2 * Implementation of the Local Printmonitor User Interface
4 * Copyright 2007 Detlef Riekenberg
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library 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 GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23 #define NONAMELESSUNION
32 #include "ddk/winsplp.h"
34 #include "wine/debug.h"
35 #include "wine/unicode.h"
38 WINE_DEFAULT_DEBUG_CHANNEL(localui);
40 /*****************************************************/
42 static HINSTANCE LOCALUI_hInstance;
44 static const WCHAR cmd_AddPortW[] = {'A','d','d','P','o','r','t',0};
45 static const WCHAR cmd_ConfigureLPTPortCommandOKW[] = {'C','o','n','f','i','g','u','r','e',
46 'L','P','T','P','o','r','t',
47 'C','o','m','m','a','n','d','O','K',0};
48 static const WCHAR cmd_DeletePortW[] = {'D','e','l','e','t','e','P','o','r','t',0};
49 static const WCHAR cmd_GetDefaultCommConfigW[] = {'G','e','t',
50 'D','e','f','a','u','l','t',
51 'C','o','m','m','C','o','n','f','i','g',0};
52 static const WCHAR cmd_GetTransmissionRetryTimeoutW[] = {'G','e','t',
53 'T','r','a','n','s','m','i','s','s','i','o','n',
54 'R','e','t','r','y','T','i','m','e','o','u','t',0};
55 static const WCHAR cmd_PortIsValidW[] = {'P','o','r','t','I','s','V','a','l','i','d',0};
56 static const WCHAR cmd_SetDefaultCommConfigW[] = {'S','e','t',
57 'D','e','f','a','u','l','t',
58 'C','o','m','m','C','o','n','f','i','g',0};
60 static const WCHAR fmt_uW[] = {'%','u',0};
61 static const WCHAR portname_LPT[] = {'L','P','T',0};
62 static const WCHAR portname_COM[] = {'C','O','M',0};
63 static const WCHAR portname_FILE[] = {'F','I','L','E',':',0};
64 static const WCHAR portname_CUPS[] = {'C','U','P','S',':',0};
65 static const WCHAR portname_LPR[] = {'L','P','R',':',0};
67 static const WCHAR XcvMonitorW[] = {',','X','c','v','M','o','n','i','t','o','r',' ',0};
68 static const WCHAR XcvPortW[] = {',','X','c','v','P','o','r','t',' ',0};
70 /*****************************************************/
72 typedef struct tag_addportui_t {
77 typedef struct tag_lptconfig_t {
83 static INT_PTR CALLBACK dlgproc_lptconfig(HWND hwnd, UINT msg, WPARAM wparam, LPARAM lparam);
85 /*****************************************************
89 static LPWSTR strdupWW(LPCWSTR pPrefix, LPCWSTR pSuffix)
94 len = lstrlenW(pPrefix) + (pSuffix ? lstrlenW(pSuffix) : 0) + 1;
95 ptr = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
97 lstrcpyW(ptr, pPrefix);
98 if (pSuffix) lstrcatW(ptr, pSuffix);
103 /*****************************************************
104 * dlg_configure_com [internal]
108 static BOOL dlg_configure_com(HANDLE hXcv, HWND hWnd, PCWSTR pPortName)
117 /* strip the colon (pPortName is never empty here) */
118 len = lstrlenW(pPortName);
119 shortname = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
121 memcpy(shortname, pPortName, (len -1) * sizeof(WCHAR));
122 shortname[len-1] = '\0';
124 /* get current settings */
125 len = FIELD_OFFSET(COMMCONFIG, wcProviderData[1]);
126 status = ERROR_SUCCESS;
127 res = XcvDataW( hXcv, cmd_GetDefaultCommConfigW,
129 (lstrlenW(shortname) +1) * sizeof(WCHAR),
130 (PBYTE) &cfg, len, &len, &status);
132 if (res && (status == ERROR_SUCCESS)) {
133 /* display the Dialog */
134 res = CommConfigDialogW(pPortName, hWnd, &cfg);
136 status = ERROR_SUCCESS;
137 /* set new settings */
138 res = XcvDataW(hXcv, cmd_SetDefaultCommConfigW,
140 (PBYTE) &dummy, 0, &len, &status);
143 HeapFree(GetProcessHeap(), 0, shortname);
150 /*****************************************************
151 * dlg_configure_lpt [internal]
155 static BOOL dlg_configure_lpt(HANDLE hXcv, HWND hWnd)
163 res = DialogBoxParamW(LOCALUI_hInstance, MAKEINTRESOURCEW(LPTCONFIG_DIALOG), hWnd,
164 dlgproc_lptconfig, (LPARAM) &data);
166 TRACE("got %u with %u\n", res, GetLastError());
168 if (!res) SetLastError(ERROR_CANCELLED);
172 /******************************************************************
173 * dlg_port_already_exists [internal]
176 static void dlg_port_already_exists(HWND hWnd, LPCWSTR portname)
178 WCHAR res_PortW[IDS_LOCALPORT_MAXLEN];
179 WCHAR res_PortExistsW[IDS_PORTEXISTS_MAXLEN];
184 res_PortExistsW[0] = '\0';
185 LoadStringW(LOCALUI_hInstance, IDS_LOCALPORT, res_PortW, IDS_LOCALPORT_MAXLEN);
186 LoadStringW(LOCALUI_hInstance, IDS_PORTEXISTS, res_PortExistsW, IDS_PORTEXISTS_MAXLEN);
188 len = lstrlenW(portname) + IDS_PORTEXISTS_MAXLEN + 1;
189 message = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
192 snprintfW(message, len, res_PortExistsW, portname);
193 MessageBoxW(hWnd, message, res_PortW, MB_OK | MB_ICONERROR);
194 HeapFree(GetProcessHeap(), 0, message);
198 /******************************************************************
199 * dlg_invalid_portname [internal]
202 static void dlg_invalid_portname(HWND hWnd, LPCWSTR portname)
204 WCHAR res_PortW[IDS_LOCALPORT_MAXLEN];
205 WCHAR res_InvalidNameW[IDS_INVALIDNAME_MAXLEN];
210 res_InvalidNameW[0] = '\0';
211 LoadStringW(LOCALUI_hInstance, IDS_LOCALPORT, res_PortW, IDS_LOCALPORT_MAXLEN);
212 LoadStringW(LOCALUI_hInstance, IDS_INVALIDNAME, res_InvalidNameW, IDS_INVALIDNAME_MAXLEN);
214 len = lstrlenW(portname) + IDS_INVALIDNAME_MAXLEN;
215 message = HeapAlloc(GetProcessHeap(), 0, len * sizeof(WCHAR));
218 snprintfW(message, len, res_InvalidNameW, portname);
219 MessageBoxW(hWnd, message, res_PortW, MB_OK | MB_ICONERROR);
220 HeapFree(GetProcessHeap(), 0, message);
224 /******************************************************************
225 * display the Dialog "Nothing to configure"
229 static void dlg_nothingtoconfig(HWND hWnd)
231 WCHAR res_PortW[IDS_LOCALPORT_MAXLEN];
232 WCHAR res_nothingW[IDS_NOTHINGTOCONFIG_MAXLEN];
235 res_nothingW[0] = '\0';
236 LoadStringW(LOCALUI_hInstance, IDS_LOCALPORT, res_PortW, IDS_LOCALPORT_MAXLEN);
237 LoadStringW(LOCALUI_hInstance, IDS_NOTHINGTOCONFIG, res_nothingW, IDS_NOTHINGTOCONFIG_MAXLEN);
239 MessageBoxW(hWnd, res_nothingW, res_PortW, MB_OK | MB_ICONINFORMATION);
242 /******************************************************************
243 * dlg_win32error [internal]
246 static void dlg_win32error(HWND hWnd, DWORD lasterror)
248 WCHAR res_PortW[IDS_LOCALPORT_MAXLEN];
249 LPWSTR message = NULL;
253 LoadStringW(LOCALUI_hInstance, IDS_LOCALPORT, res_PortW, IDS_LOCALPORT_MAXLEN);
256 res = FormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
257 NULL, lasterror, 0, (LPWSTR) &message, 0, NULL);
260 MessageBoxW(hWnd, message, res_PortW, MB_OK | MB_ICONERROR);
265 /*****************************************************************************
269 static INT_PTR CALLBACK dlgproc_addport(HWND hwnd, UINT msg, WPARAM wparam, LPARAM lparam)
280 SetWindowLongPtrW(hwnd, DWLP_USER, lparam);
284 if (wparam == MAKEWPARAM(IDOK, BN_CLICKED))
286 data = (addportui_t *) GetWindowLongPtrW(hwnd, DWLP_USER);
287 /* length in WCHAR, without the '\0' */
288 len = SendDlgItemMessageW(hwnd, ADDPORT_EDIT, WM_GETTEXTLENGTH, 0, 0);
289 data->portname = HeapAlloc(GetProcessHeap(), 0, (len + 1) * sizeof(WCHAR));
291 if (!data->portname) {
292 EndDialog(hwnd, FALSE);
295 /* length is in WCHAR, including the '\0' */
296 GetDlgItemTextW(hwnd, ADDPORT_EDIT, data->portname, len + 1);
297 status = ERROR_SUCCESS;
298 res = XcvDataW( data->hXcv, cmd_PortIsValidW, (PBYTE) data->portname,
299 (lstrlenW(data->portname) + 1) * sizeof(WCHAR),
300 (PBYTE) &dummy, 0, &len, &status);
302 TRACE("got %u with status %u\n", res, status);
303 if (res && (status == ERROR_SUCCESS)) {
304 /* The caller must free data->portname */
305 EndDialog(hwnd, TRUE);
309 if (res && (status == ERROR_INVALID_NAME)) {
310 dlg_invalid_portname(hwnd, data->portname);
311 HeapFree(GetProcessHeap(), 0, data->portname);
312 data->portname = NULL;
316 dlg_win32error(hwnd, status);
317 HeapFree(GetProcessHeap(), 0, data->portname);
318 data->portname = NULL;
322 if (wparam == MAKEWPARAM(IDCANCEL, BN_CLICKED))
324 EndDialog(hwnd, FALSE);
332 /*****************************************************************************
333 * dlgproc_lptconfig [internal]
335 * Our message-proc is simple, as the range-check is done only during the
336 * command "OK" and the dialog is set to the start-value at "out of range".
338 * Native localui.dll does the check during keyboard-input and set the dialog
339 * to the previous value.
343 static INT_PTR CALLBACK dlgproc_lptconfig(HWND hwnd, UINT msg, WPARAM wparam, LPARAM lparam)
356 SetWindowLongPtrW(hwnd, DWLP_USER, lparam);
357 data = (lptconfig_t *) lparam;
359 /* Get current setting */
361 status = ERROR_SUCCESS;
362 res = XcvDataW( data->hXcv, cmd_GetTransmissionRetryTimeoutW,
364 (PBYTE) &data->value, sizeof(data->value), &len, &status);
366 TRACE("got %u with status %u\n", res, status);
368 /* Set current setting as the initial value in the Dialog */
369 SetDlgItemInt(hwnd, LPTCONFIG_EDIT, data->value, FALSE);
373 if (wparam == MAKEWPARAM(IDOK, BN_CLICKED))
375 data = (lptconfig_t *) GetWindowLongPtrW(hwnd, DWLP_USER);
378 res = GetDlgItemInt(hwnd, LPTCONFIG_EDIT, (BOOL *) &status, FALSE);
379 /* length is in WCHAR, including the '\0' */
380 GetDlgItemTextW(hwnd, LPTCONFIG_EDIT, bufferW, sizeof(bufferW) / sizeof(bufferW[0]));
381 TRACE("got %s and %u (translated: %u)\n", debugstr_w(bufferW), res, status);
383 /* native localui.dll use the same limits */
384 if ((res > 0) && (res < 1000000) && status) {
385 sprintfW(bufferW, fmt_uW, res);
386 res = XcvDataW( data->hXcv, cmd_ConfigureLPTPortCommandOKW,
388 (lstrlenW(bufferW) +1) * sizeof(WCHAR),
389 (PBYTE) &dummy, 0, &len, &status);
391 TRACE("got %u with status %u\n", res, status);
392 EndDialog(hwnd, TRUE);
396 /* Set initial value and rerun the Dialog */
397 SetDlgItemInt(hwnd, LPTCONFIG_EDIT, data->value, FALSE);
401 if (wparam == MAKEWPARAM(IDCANCEL, BN_CLICKED))
403 EndDialog(hwnd, FALSE);
412 /*****************************************************
413 * get_type_from_name (internal)
417 static DWORD get_type_from_name(LPCWSTR name)
421 if (!strncmpiW(name, portname_LPT, sizeof(portname_LPT) / sizeof(WCHAR) -1))
424 if (!strncmpiW(name, portname_COM, sizeof(portname_COM) / sizeof(WCHAR) -1))
427 if (!strcmpiW(name, portname_FILE))
431 return PORT_IS_UNIXNAME;
436 if (!strncmpW(name, portname_CUPS, sizeof(portname_CUPS) / sizeof(WCHAR) -1))
439 if (!strncmpW(name, portname_LPR, sizeof(portname_LPR) / sizeof(WCHAR) -1))
442 /* Must be a file or a directory. Does the file exist ? */
443 hfile = CreateFileW(name, GENERIC_WRITE, 0, NULL, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, NULL);
444 TRACE("%p for OPEN_EXISTING on %s\n", hfile, debugstr_w(name));
445 if (hfile == INVALID_HANDLE_VALUE) {
446 /* Can we create the file? */
447 hfile = CreateFileW(name, GENERIC_WRITE, 0, NULL, OPEN_ALWAYS, FILE_FLAG_DELETE_ON_CLOSE, NULL);
448 TRACE("%p for OPEN_ALWAYS\n", hfile);
450 if (hfile != INVALID_HANDLE_VALUE) {
452 return PORT_IS_FILENAME;
454 /* We can't use the name. use GetLastError() for the reason */
455 return PORT_IS_UNKNOWN;
458 /*****************************************************
459 * open_monitor_by_name [internal]
462 static BOOL open_monitor_by_name(LPCWSTR pPrefix, LPCWSTR pPort, HANDLE * phandle)
464 PRINTER_DEFAULTSW pd;
469 TRACE("(%s,%s)\n", debugstr_w(pPrefix),debugstr_w(pPort) );
471 fullname = strdupWW(pPrefix, pPort);
474 pd.DesiredAccess = SERVER_ACCESS_ADMINISTER;
476 res = OpenPrinterW(fullname, phandle, &pd);
477 HeapFree(GetProcessHeap(), 0, fullname);
481 /*****************************************************
482 * localui_AddPortUI [exported through MONITORUI]
484 * Display a Dialog to add a local Port
487 * pName [I] Servername or NULL (local Computer)
488 * hWnd [I] Handle to parent Window for the Dialog-Box or NULL
489 * pMonitorName[I] Name of the Monitor, that should be used to add a Port or NULL
490 * ppPortName [O] PTR to PTR of a buffer, that receive the Name of the new Port or NULL
497 * The caller must free the buffer (returned in ppPortName) with GlobalFree().
498 * Native localui.dll failed with ERROR_INVALID_PARAMETER, when the user tried
499 * to add a Port, that start with "COM" or "LPT".
502 static BOOL WINAPI localui_AddPortUI(PCWSTR pName, HWND hWnd, PCWSTR pMonitorName, PWSTR *ppPortName)
511 TRACE( "(%s, %p, %s, %p) (*ppPortName: %p)\n", debugstr_w(pName), hWnd,
512 debugstr_w(pMonitorName), ppPortName, ppPortName ? *ppPortName : NULL);
514 if (open_monitor_by_name(XcvMonitorW, pMonitorName, &hXcv)) {
516 ZeroMemory(&data, sizeof(addportui_t));
518 res = DialogBoxParamW(LOCALUI_hInstance, MAKEINTRESOURCEW(ADDPORT_DIALOG), hWnd,
519 dlgproc_addport, (LPARAM) &data);
521 TRACE("got %u with %u for %s\n", res, GetLastError(), debugstr_w(data.portname));
523 if (ppPortName) *ppPortName = NULL;
526 res = XcvDataW(hXcv, cmd_AddPortW, (PBYTE) data.portname,
527 (lstrlenW(data.portname)+1) * sizeof(WCHAR),
528 (PBYTE) &dummy, 0, &needed, &status);
530 TRACE("got %u with status %u\n", res, status);
531 if (res && (status == ERROR_SUCCESS) && ppPortName) {
532 /* Native localui uses GlobalAlloc also.
533 The caller must GlobalFree the buffer */
534 *ppPortName = GlobalAlloc(GPTR, (lstrlenW(data.portname)+1) * sizeof(WCHAR));
535 if (*ppPortName) lstrcpyW(*ppPortName, data.portname);
538 if (res && (status == ERROR_ALREADY_EXISTS)) {
539 dlg_port_already_exists(hWnd, data.portname);
540 /* Native localui also return "TRUE" from AddPortUI in this case */
543 HeapFree(GetProcessHeap(), 0, data.portname);
547 SetLastError(ERROR_CANCELLED);
552 TRACE("=> %u with %u\n", res, GetLastError());
557 /*****************************************************
558 * localui_ConfigurePortUI [exported through MONITORUI]
560 * Display the Configuration-Dialog for a specific Port
563 * pName [I] Servername or NULL (local Computer)
564 * hWnd [I] Handle to parent Window for the Dialog-Box or NULL
565 * pPortName [I] Name of the Port, that should be configured
572 static BOOL WINAPI localui_ConfigurePortUI(PCWSTR pName, HWND hWnd, PCWSTR pPortName)
577 TRACE("(%s, %p, %s)\n", debugstr_w(pName), hWnd, debugstr_w(pPortName));
578 if (open_monitor_by_name(XcvPortW, pPortName, &hXcv)) {
580 res = get_type_from_name(pPortName);
585 res = dlg_configure_com(hXcv, hWnd, pPortName);
589 res = dlg_configure_lpt(hXcv, hWnd);
593 dlg_nothingtoconfig(hWnd);
594 SetLastError(ERROR_CANCELLED);
605 /*****************************************************
606 * localui_DeletePortUI [exported through MONITORUI]
608 * Delete a specific Port
611 * pName [I] Servername or NULL (local Computer)
612 * hWnd [I] Handle to parent Window
613 * pPortName [I] Name of the Port, that should be deleted
620 * Native localui does not allow to delete a COM / LPT - Port (ERROR_NOT_SUPPORTED)
623 static BOOL WINAPI localui_DeletePortUI(PCWSTR pName, HWND hWnd, PCWSTR pPortName)
630 TRACE("(%s, %p, %s)\n", debugstr_w(pName), hWnd, debugstr_w(pPortName));
632 if ((!pPortName) || (!pPortName[0])) {
633 SetLastError(ERROR_INVALID_PARAMETER);
637 if (open_monitor_by_name(XcvPortW, pPortName, &hXcv)) {
638 /* native localui tests here for LPT / COM - Ports and failed with
639 ERROR_NOT_SUPPORTED. */
640 if (XcvDataW(hXcv, cmd_DeletePortW, (LPBYTE) pPortName,
641 (lstrlenW(pPortName)+1) * sizeof(WCHAR), (LPBYTE) &dummy, 0, &needed, &status)) {
644 if (status != ERROR_SUCCESS) SetLastError(status);
645 return (status == ERROR_SUCCESS);
650 SetLastError(ERROR_UNKNOWN_PORT);
654 /*****************************************************
655 * InitializePrintMonitorUI (LOCALUI.@)
657 * Initialize the User-Interface for the Local Ports
660 * Success: Pointer to a MONITORUI Structure
665 PMONITORUI WINAPI InitializePrintMonitorUI(void)
667 static MONITORUI mymonitorui =
671 localui_ConfigurePortUI,
675 TRACE("=> %p\n", &mymonitorui);
679 /*****************************************************
682 BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved)
684 TRACE("(%p, %d, %p)\n",hinstDLL, fdwReason, lpvReserved);
688 case DLL_PROCESS_ATTACH:
689 DisableThreadLibraryCalls( hinstDLL );
690 LOCALUI_hInstance = hinstDLL;