* PROJECT: ReactOS Local Spooler
* LICENSE: GNU LGPL v2.1 or any later version as published by the Free Software Foundation
* PURPOSE: Functions related to Printers and printing
- * COPYRIGHT: Copyright 2015 Colin Finck <colin@reactos.org>
+ * COPYRIGHT: Copyright 2015-2017 Colin Finck <colin@reactos.org>
*/
#include "precomp.h"
// Global Variables
SKIPLIST PrinterList;
+// Local Constants
+static DWORD dwPrinterInfo1Offsets[] = {
+ FIELD_OFFSET(PRINTER_INFO_1W, pName),
+ FIELD_OFFSET(PRINTER_INFO_1W, pComment),
+ FIELD_OFFSET(PRINTER_INFO_1W, pDescription),
+ MAXDWORD
+};
/**
* @name _PrinterListCompareRoutine
DWORD i;
HKEY hKey = NULL;
HKEY hSubKey = NULL;
+ PLOCAL_PORT pPort;
PLOCAL_PRINTER pPrinter = NULL;
PLOCAL_PRINT_PROCESSOR pPrintProcessor;
+ PWSTR pwszPort = NULL;
PWSTR pwszPrintProcessor = NULL;
WCHAR wszPrinterName[MAX_PRINTER_NAME + 1];
continue;
}
+ // Get the Port.
+ pwszPort = AllocAndRegQueryWSZ(hSubKey, L"Port");
+ if (!pwszPort)
+ continue;
+
+ // Try to find it in the Port List.
+ pPort = FindPort(pwszPort);
+ if (!pPort)
+ {
+ ERR("Invalid Port \"%S\" for Printer \"%S\"!\n", pwszPort, wszPrinterName);
+ continue;
+ }
+
// Create a new LOCAL_PRINTER structure for it.
pPrinter = DllAllocSplMem(sizeof(LOCAL_PRINTER));
if (!pPrinter)
pPrinter->pwszPrinterName = AllocSplStr(wszPrinterName);
pPrinter->pPrintProcessor = pPrintProcessor;
+ pPrinter->pPort = pPort;
InitializePrinterJobList(pPrinter);
+ // Get the location.
+ pPrinter->pwszLocation = AllocAndRegQueryWSZ(hSubKey, L"Location");
+ if (!pPrinter->pwszLocation)
+ continue;
+
// Get the printer driver.
pPrinter->pwszPrinterDriver = AllocAndRegQueryWSZ(hSubKey, L"Printer Driver");
if (!pPrinter->pwszPrinterDriver)
return (dwErrorCode == ERROR_SUCCESS);
}
+/**
+ * @name _IsLocalComputerName
+ *
+ * Checks if the given Computer Name matches the local Computer Name.
+ *
+ * @param Name
+ * Computer Name prepended with two backslashes to check.
+ *
+ * @param pwszComputerName
+ * Pointer to a string able to hold 2 + MAX_COMPUTERNAME_LENGTH + 1 + 1 characters.
+ * Will contain a string "\\COMPUTERNAME\" on success that can be prepended in EnumPrinters.
+ *
+ * @param pcchComputerName
+ * On success, this pointer receives the length in characters of pwszComputerName.
+ *
+ * @return
+ * ERROR_SUCCESS on success or an error code on failure.
+ */
+static DWORD
+_IsLocalComputerName(PCWSTR Name, PWSTR pwszComputerName, PDWORD pcchComputerName)
+{
+ DWORD dwErrorCode;
+
+ // Prepend slashes to the computer name.
+ pwszComputerName[0] = L'\\';
+ pwszComputerName[1] = L'\\';
+
+ // Get the local computer name for comparison.
+ *pcchComputerName = MAX_COMPUTERNAME_LENGTH + 1;
+ if (!GetComputerNameW(&pwszComputerName[2], pcchComputerName))
+ {
+ dwErrorCode = GetLastError();
+ ERR("GetComputerNameW failed with error %lu!\n", dwErrorCode);
+ goto Cleanup;
+ }
+
+ // Add the leading slashes to the total length.
+ *pcchComputerName += 2;
+
+ // Now compare this with the local computer name and reject it with ERROR_INVALID_NAME if it doesn't match.
+ if (wcsicmp(&Name[2], &pwszComputerName[2]) != 0)
+ {
+ dwErrorCode = ERROR_INVALID_NAME;
+ goto Cleanup;
+ }
+
+ // Add a trailing backslash to pwszComputerName, which will later be prepended in front of the printer names.
+ pwszComputerName[(*pcchComputerName)++] = L'\\';
+ pwszComputerName[*pcchComputerName] = 0;
+
+ dwErrorCode = ERROR_SUCCESS;
+
+Cleanup:
+ return dwErrorCode;
+}
+
+static DWORD
+_DumpLevel1PrintProviderInformation(PBYTE pPrinterEnum, DWORD cbBuf, PDWORD pcbNeeded, PDWORD pcReturned)
+{
+ int i;
+
+ // Count the needed bytes for Print Provider information.
+ *pcbNeeded = sizeof(PRINTER_INFO_1W);
+
+ for (i = 0; i < 3; i++)
+ *pcbNeeded += (wcslen(wszPrintProviderInfo[i]) + 1) * sizeof(WCHAR);
+
+ // Check if the supplied buffer is large enough.
+ if (cbBuf < *pcbNeeded)
+ return ERROR_INSUFFICIENT_BUFFER;
+
+ // Copy over the Print Provider information.
+ ((PPRINTER_INFO_1W)pPrinterEnum)->Flags = 0;
+ PackStrings(wszPrintProviderInfo, pPrinterEnum, dwPrinterInfo1Offsets, &pPrinterEnum[*pcbNeeded]);
+ *pcReturned = 1;
+
+ return ERROR_SUCCESS;
+}
+
+static DWORD
+_LocalEnumPrintersLevel0(DWORD Flags, PCWSTR Name, PBYTE pPrinterEnum, DWORD cbBuf, PDWORD pcbNeeded, PDWORD pcReturned)
+{
+ return ERROR_INVALID_LEVEL;
+}
-DWORD
-_LocalEnumPrintersLevel1(DWORD Flags, LPWSTR Name, LPBYTE pPrinterEnum, DWORD cbBuf, LPDWORD pcbNeeded, LPDWORD pcReturned)
+static DWORD
+_LocalEnumPrintersLevel1(DWORD Flags, PCWSTR Name, PBYTE pPrinterEnum, DWORD cbBuf, PDWORD pcbNeeded, PDWORD pcReturned)
{
const WCHAR wszComma[] = L",";
- DWORD cbName;
- DWORD cbComment;
- DWORD cbDescription;
+ size_t cbName;
+ size_t cbComment;
+ size_t cbDescription;
DWORD cchComputerName = 0;
DWORD dwErrorCode;
DWORD i;
PBYTE pPrinterInfo;
- PBYTE pPrinterString;
+ PBYTE pPrinterStrings;
PSKIPLIST_NODE pNode;
PLOCAL_PRINTER pPrinter;
- PRINTER_INFO_1W PrinterInfo1;
- WCHAR wszComputerName[2 + MAX_COMPUTERNAME_LENGTH + 1 + 1];
-
- DWORD dwOffsets[] = {
- FIELD_OFFSET(PRINTER_INFO_1W, pName),
- FIELD_OFFSET(PRINTER_INFO_1W, pDescription),
- FIELD_OFFSET(PRINTER_INFO_1W, pComment),
- MAXDWORD
- };
+ PWSTR p;
+ PWSTR pwszStrings[3];
+ WCHAR wszComputerName[2 + MAX_COMPUTERNAME_LENGTH + 1 + 1] = { 0 };
if (Flags & PRINTER_ENUM_NAME)
{
if (Name)
{
// The user supplied a Computer Name (with leading double backslashes) or Print Provider Name.
- // Only process what's directed at us and dismiss every other request with ERROR_INVALID_NAME.
+ // Only process what's directed at us.
if (Name[0] == L'\\' && Name[1] == L'\\')
{
- // Prepend slashes to the computer name.
- wszComputerName[0] = L'\\';
- wszComputerName[1] = L'\\';
-
- // Get the local computer name for comparison.
- cchComputerName = MAX_COMPUTERNAME_LENGTH + 1;
- if (!GetComputerNameW(&wszComputerName[2], &cchComputerName))
- {
- dwErrorCode = GetLastError();
- ERR("GetComputerNameW failed with error %lu!\n", dwErrorCode);
+ dwErrorCode = _IsLocalComputerName(Name, wszComputerName, &cchComputerName);
+ if (dwErrorCode != ERROR_SUCCESS)
goto Cleanup;
- }
-
- // Add the leading slashes to the total length.
- cchComputerName += 2;
-
- // Now compare this with the local computer name and reject if it doesn't match.
- if (wcsicmp(&Name[2], &wszComputerName[2]) != 0)
- {
- dwErrorCode = ERROR_INVALID_NAME;
- goto Cleanup;
- }
-
- // Add a trailing backslash to wszComputerName, which will later be prepended in front of the printer names.
- wszComputerName[cchComputerName++] = L'\\';
- wszComputerName[cchComputerName] = 0;
}
else if (wcsicmp(Name, wszPrintProviderInfo[0]) != 0)
{
- // The user supplied a name that cannot be processed by the local print provider.
+ // The user supplied a name that cannot be processed by the Local Print Provider.
dwErrorCode = ERROR_INVALID_NAME;
goto Cleanup;
}
{
// The caller wants information about this Print Provider.
// spoolss packs this into an array of information about all Print Providers.
- *pcbNeeded = sizeof(PRINTER_INFO_1W);
-
- for (i = 0; i < 3; i++)
- *pcbNeeded += (wcslen(wszPrintProviderInfo[i]) + 1) * sizeof(WCHAR);
-
- // Check if the supplied buffer is large enough.
- if (cbBuf < *pcbNeeded)
- {
- dwErrorCode = ERROR_INSUFFICIENT_BUFFER;
- goto Cleanup;
- }
-
- // Copy over the print processor information.
- ((PPRINTER_INFO_1W)pPrinterEnum)->Flags = 0;
- PackStrings(wszPrintProviderInfo, pPrinterEnum, dwOffsets, &pPrinterEnum[*pcbNeeded]);
- *pcReturned = 1;
- dwErrorCode = ERROR_SUCCESS;
+ dwErrorCode = _DumpLevel1PrintProviderInformation(pPrinterEnum, cbBuf, pcbNeeded, pcReturned);
goto Cleanup;
}
}
{
pPrinter = (PLOCAL_PRINTER)pNode->Element;
- // This looks wrong, but is totally right. PRINTER_INFO_1W has three members pName, pComment and pDescription.
- // But pComment equals the "Description" registry value while pDescription is concatenated out of pName and pComment.
+ // TODO: If PRINTER_ENUM_SHARED is given, add this Printer if it's shared instead of just ignoring it.
+ if (Flags & PRINTER_ENUM_SHARED)
+ continue;
+
+ // Attention: pComment equals the "Description" registry value while pDescription is concatenated out of several strings.
// On top of this, the computer name is prepended to the printer name if the user supplied the local computer name during the query.
- cbName = (wcslen(pPrinter->pwszPrinterName) + 1) * sizeof(WCHAR);
+ cbName = (cchComputerName + wcslen(pPrinter->pwszPrinterName) + 1) * sizeof(WCHAR);
cbComment = (wcslen(pPrinter->pwszDescription) + 1) * sizeof(WCHAR);
- cbDescription = cchComputerName * sizeof(WCHAR) + cbName + cbComment + sizeof(WCHAR);
+ cbDescription = cbName + (wcslen(pPrinter->pwszPrinterDriver) + 1 + wcslen(pPrinter->pwszLocation) + 1) * sizeof(WCHAR);
- *pcbNeeded += sizeof(PRINTER_INFO_1W) + cchComputerName * sizeof(WCHAR) + cbName + cbComment + cbDescription;
+ *pcbNeeded += sizeof(PRINTER_INFO_1W) + cbName + cbComment + cbDescription;
i++;
}
goto Cleanup;
}
- // Put the strings right after the last PRINTER_INFO_1W structure.
- // Due to all the required string processing, we can't just use PackStrings here :(
+ // Initialize the variables for filling the output buffer using PackStrings.
pPrinterInfo = pPrinterEnum;
- pPrinterString = pPrinterEnum + i * sizeof(PRINTER_INFO_1W);
+ pPrinterStrings = &pPrinterEnum[*pcbNeeded];
- // Copy over the printer information.
+ // Copy over the Printer information.
for (pNode = PrinterList.Head.Next[0]; pNode; pNode = pNode->Next[0])
{
pPrinter = (PLOCAL_PRINTER)pNode->Element;
- // FIXME: As for now, the Flags member returns no information.
- PrinterInfo1.Flags = 0;
+ // TODO: If PRINTER_ENUM_SHARED is given, add this Printer if it's shared instead of just ignoring it.
+ if (Flags & PRINTER_ENUM_SHARED)
+ continue;
- // Copy the printer name.
- PrinterInfo1.pName = (PWSTR)pPrinterString;
- CopyMemory(pPrinterString, wszComputerName, cchComputerName * sizeof(WCHAR));
- pPrinterString += cchComputerName * sizeof(WCHAR);
- cbName = (wcslen(pPrinter->pwszPrinterName) + 1) * sizeof(WCHAR);
- CopyMemory(pPrinterString, pPrinter->pwszPrinterName, cbName);
- pPrinterString += cbName;
+ // Indicate that this is a Printer.
+ ((PPRINTER_INFO_1W)pPrinterInfo)->Flags = PRINTER_ENUM_ICON8;
- // Copy the printer comment (equals the "Description" registry value).
- PrinterInfo1.pComment = (PWSTR)pPrinterString;
+ // Calculate the string lengths.
+ cbName = (cchComputerName + wcslen(pPrinter->pwszPrinterName) + 1) * sizeof(WCHAR);
cbComment = (wcslen(pPrinter->pwszDescription) + 1) * sizeof(WCHAR);
- CopyMemory(pPrinterString, pPrinter->pwszDescription, cbComment);
- pPrinterString += cbComment;
-
- // Copy the description, which for PRINTER_INFO_1W has the form "Name,Comment,"
- PrinterInfo1.pDescription = (PWSTR)pPrinterString;
- CopyMemory(pPrinterString, wszComputerName, cchComputerName * sizeof(WCHAR));
- pPrinterString += cchComputerName * sizeof(WCHAR);
- CopyMemory(pPrinterString, pPrinter->pwszPrinterName, cbName - sizeof(WCHAR));
- pPrinterString += cbName - sizeof(WCHAR);
- CopyMemory(pPrinterString, wszComma, sizeof(WCHAR));
- pPrinterString += sizeof(WCHAR);
- CopyMemory(pPrinterString, pPrinter->pwszDescription, cbComment - sizeof(WCHAR));
- pPrinterString += cbComment - sizeof(WCHAR);
- CopyMemory(pPrinterString, wszComma, sizeof(wszComma));
- pPrinterString += sizeof(wszComma);
-
+ cbDescription = cbName + (wcslen(pPrinter->pwszPrinterDriver) + 1 + wcslen(pPrinter->pwszLocation) + 1) * sizeof(WCHAR);
+
+ // Copy the Printer Name.
+ pwszStrings[0] = DllAllocSplMem(cbName);
+ p = pwszStrings[0];
+ StringCbCopyExW(p, cbName, wszComputerName, &p, &cbName, 0);
+ StringCbCopyExW(p, cbName, pPrinter->pwszPrinterName, &p, &cbName, 0);
+
+ // Copy the Printer comment (equals the "Description" registry value).
+ pwszStrings[1] = pPrinter->pwszDescription;
+
+ // Copy the description, which for PRINTER_INFO_1W has the form "Name,Printer Driver,Location"
+ pwszStrings[2] = DllAllocSplMem(cbDescription);
+ p = pwszStrings[2];
+ StringCbCopyExW(p, cbDescription, wszComputerName, &p, &cbDescription, 0);
+ StringCbCopyExW(p, cbDescription, pPrinter->pwszPrinterName, &p, &cbDescription, 0);
+ StringCbCopyExW(p, cbDescription, wszComma, &p, &cbDescription, 0);
+ StringCbCopyExW(p, cbDescription, pPrinter->pwszPrinterDriver, &p, &cbDescription, 0);
+ StringCbCopyExW(p, cbDescription, wszComma, &p, &cbDescription, 0);
+ StringCbCopyExW(p, cbDescription, pPrinter->pwszLocation, &p, &cbDescription, 0);
+
// Finally copy the structure and advance to the next one in the output buffer.
- CopyMemory(pPrinterInfo, &PrinterInfo1, sizeof(PRINTER_INFO_1W));
+ pPrinterStrings = PackStrings(pwszStrings, pPrinterInfo, dwPrinterInfo1Offsets, pPrinterStrings);
pPrinterInfo += sizeof(PRINTER_INFO_1W);
+
+ // Free the memory for temporary strings.
+ DllFreeSplMem(pwszStrings[0]);
+ DllFreeSplMem(pwszStrings[2]);
}
*pcReturned = i;
return dwErrorCode;
}
+static DWORD
+_LocalEnumPrintersLevel2(DWORD Flags, PCWSTR Name, PBYTE pPrinterEnum, DWORD cbBuf, PDWORD pcbNeeded, PDWORD pcReturned)
+{
+ return ERROR_INVALID_LEVEL;
+}
+
+static DWORD
+_LocalEnumPrintersLevel4(DWORD Flags, PCWSTR Name, PBYTE pPrinterEnum, DWORD cbBuf, PDWORD pcbNeeded, PDWORD pcReturned)
+{
+ return ERROR_INVALID_LEVEL;
+}
+
+static DWORD
+_LocalEnumPrintersLevel5(DWORD Flags, PCWSTR Name, PBYTE pPrinterEnum, DWORD cbBuf, PDWORD pcbNeeded, PDWORD pcReturned)
+{
+ return ERROR_INVALID_LEVEL;
+}
+
BOOL WINAPI
LocalEnumPrinters(DWORD Flags, LPWSTR Name, DWORD Level, LPBYTE pPrinterEnum, DWORD cbBuf, LPDWORD pcbNeeded, LPDWORD pcReturned)
{
*pcbNeeded = 0;
*pcReturned = 0;
- // Think positive :)
- // Treat it as success if the caller queried no information and we don't need to return any.
- dwErrorCode = ERROR_SUCCESS;
+ if (Flags & PRINTER_ENUM_CONNECTIONS || Flags & PRINTER_ENUM_REMOTE || Flags & PRINTER_ENUM_NETWORK)
+ {
+ // If the flags for the Network Print Provider are given, bail out with ERROR_INVALID_NAME.
+ // This is the internal way for a Print Provider to signal that it doesn't handle this request.
+ dwErrorCode = ERROR_INVALID_NAME;
+ goto Cleanup;
+ }
- if (Flags & PRINTER_ENUM_LOCAL)
+ if (!(Flags & PRINTER_ENUM_LOCAL || Flags & PRINTER_ENUM_NAME))
{
- // The function behaves quite differently for each level.
- if (Level == 1)
- {
- dwErrorCode = _LocalEnumPrintersLevel1(Flags, Name, pPrinterEnum, cbBuf, pcbNeeded, pcReturned);
- }
- else
- {
- // TODO: Handle other levels.
- // The caller supplied an invalid level.
- dwErrorCode = ERROR_INVALID_LEVEL;
- goto Cleanup;
- }
+ // The Local Print Provider is the right destination for the request, but without any of these flags,
+ // there is no information that can be returned.
+ // So just signal a successful request.
+ dwErrorCode = ERROR_SUCCESS;
+ goto Cleanup;
+ }
+
+ if (Level == 0)
+ {
+ dwErrorCode = _LocalEnumPrintersLevel0(Flags, Name, pPrinterEnum, cbBuf, pcbNeeded, pcReturned);
+ }
+ else if (Level == 1)
+ {
+ dwErrorCode = _LocalEnumPrintersLevel1(Flags, Name, pPrinterEnum, cbBuf, pcbNeeded, pcReturned);
+ }
+ else if (Level == 2)
+ {
+ dwErrorCode = _LocalEnumPrintersLevel2(Flags, Name, pPrinterEnum, cbBuf, pcbNeeded, pcReturned);
+ }
+ else if (Level == 4)
+ {
+ dwErrorCode = _LocalEnumPrintersLevel4(Flags, Name, pPrinterEnum, cbBuf, pcbNeeded, pcReturned);
+ }
+ else if (Level == 5)
+ {
+ dwErrorCode = _LocalEnumPrintersLevel5(Flags, Name, pPrinterEnum, cbBuf, pcbNeeded, pcReturned);
+ }
+ else
+ {
+ // The caller supplied an invalid level.
+ dwErrorCode = ERROR_INVALID_LEVEL;
}
Cleanup:
PWSTR pwszSecondParameter = NULL;
PLOCAL_JOB pJob;
PLOCAL_HANDLE pHandle = NULL;
+ PLOCAL_PORT pPort;
+ PLOCAL_PORT_HANDLE pPortHandle = NULL;
PLOCAL_PRINT_MONITOR pPrintMonitor;
PLOCAL_PRINTER pPrinter;
PLOCAL_PRINTER_HANDLE pPrinterHandle = NULL;
+ PLOCAL_XCV_HANDLE pXcvHandle = NULL;
WCHAR wszComputerName[MAX_COMPUTERNAME_LENGTH + 1];
+ WCHAR wszFullPath[MAX_PATH];
// TODO: lpPrinterName == NULL is supported and means access to the local printer server.
// Not sure yet if that is passed down to localspl.dll or processed in advance.
goto Cleanup;
}
+ *phPrinter = NULL;
+
// Skip any server name in the first parameter.
// Does lpPrinterName begin with two backslashes to indicate a server name?
if (lpPrinterName[0] == L'\\' && lpPrinterName[1] == L'\\')
if (cchFirstParameter)
{
// Yes, extract it.
+ // No null-termination is necessary here, because DllAllocSplMem returns a zero-initialized buffer.
pwszFirstParameter = DllAllocSplMem((cchFirstParameter + 1) * sizeof(WCHAR));
CopyMemory(pwszFirstParameter, lpPrinterName, cchFirstParameter * sizeof(WCHAR));
- pwszFirstParameter[cchFirstParameter] = 0;
}
// Do we have a second parameter?
// "\\COMPUTERNAME\LPT1:, Port"
// Look for this port in our Print Monitor Port list.
- pPrintMonitor = FindPrintMonitorByPort(pwszFirstParameter);
- if (!pPrintMonitor)
+ pPort = FindPort(pwszFirstParameter);
+ if (!pPort)
{
// The supplied port is unknown to all our Print Monitors.
dwErrorCode = ERROR_INVALID_PRINTER_NAME;
goto Cleanup;
}
+ pPrintMonitor = pPort->pPrintMonitor;
+
// Call the monitor's OpenPort function.
if (pPrintMonitor->bIsLevel2)
bReturnValue = ((PMONITOR2)pPrintMonitor->pMonitor)->pfnOpenPort(pPrintMonitor->hMonitor, pwszFirstParameter, &hExternalHandle);
goto Cleanup;
}
+ // Create a new LOCAL_PORT_HANDLE.
+ pPortHandle = DllAllocSplMem(sizeof(LOCAL_PORT_HANDLE));
+ if (!pPortHandle)
+ {
+ dwErrorCode = ERROR_NOT_ENOUGH_MEMORY;
+ ERR("DllAllocSplMem failed with error %lu!\n", GetLastError());
+ goto Cleanup;
+ }
+
+ pPortHandle->hPort = hExternalHandle;
+ pPortHandle->pPort = pPort;
+
// Return the Port handle through our general handle.
pHandle->HandleType = HandleType_Port;
- pHandle->pSpecificHandle = hExternalHandle;
+ pHandle->pSpecificHandle = pPortHandle;
}
else if (!pwszFirstParameter && pwszSecondParameter && wcsncmp(pwszSecondParameter, L"Xcv", 3) == 0)
{
pwszSecondParameter += 5;
// Look for this port in our Print Monitor Port list.
- pPrintMonitor = FindPrintMonitorByPort(pwszSecondParameter);
- if (!pPrintMonitor)
+ pPort = FindPort(pwszFirstParameter);
+ if (!pPort)
{
// The supplied port is unknown to all our Print Monitors.
dwErrorCode = ERROR_INVALID_PRINTER_NAME;
goto Cleanup;
}
+
+ pPrintMonitor = pPort->pPrintMonitor;
}
else
{
goto Cleanup;
}
+ // Create a new LOCAL_XCV_HANDLE.
+ pXcvHandle = DllAllocSplMem(sizeof(LOCAL_XCV_HANDLE));
+ if (!pXcvHandle)
+ {
+ dwErrorCode = ERROR_NOT_ENOUGH_MEMORY;
+ ERR("DllAllocSplMem failed with error %lu!\n", GetLastError());
+ goto Cleanup;
+ }
+
+ pXcvHandle->hXcv = hExternalHandle;
+ pXcvHandle->pPrintMonitor = pPrintMonitor;
+
// Return the Xcv handle through our general handle.
pHandle->HandleType = HandleType_Xcv;
- pHandle->pSpecificHandle = hExternalHandle;
+ pHandle->pSpecificHandle = pXcvHandle;
}
else
{
goto Cleanup;
}
- // Create a new printer handle.
+ // Create a new LOCAL_PRINTER_HANDLE.
pPrinterHandle = DllAllocSplMem(sizeof(LOCAL_PRINTER_HANDLE));
if (!pPrinterHandle)
{
goto Cleanup;
}
+ pPrinterHandle->hSPLFile = INVALID_HANDLE_VALUE;
pPrinterHandle->pPrinter = pPrinter;
// Check if a datatype was given.
else
pPrinterHandle->pDevMode = DuplicateDevMode(pPrinter->pDefaultDevMode);
- // Check if the caller wants a handle to an existing job.
+ // Check if the caller wants a handle to an existing Print Job.
if (pwszSecondParameter)
{
// The "Job " string has to follow now.
goto Cleanup;
}
- pPrinterHandle->pStartedJob = pJob;
+ // Try to open its SPL file.
+ GetJobFilePath(L"SPL", dwJobID, wszFullPath);
+ pPrinterHandle->hSPLFile = CreateFileW(wszFullPath, GENERIC_READ | GENERIC_WRITE, FILE_SHARE_READ | FILE_SHARE_WRITE, NULL, OPEN_EXISTING, 0, NULL);
+ if (pPrinterHandle->hSPLFile == INVALID_HANDLE_VALUE)
+ {
+ dwErrorCode = GetLastError();
+ ERR("CreateFileW failed with error %lu for \"%S\"!", dwErrorCode, wszFullPath);
+ goto Cleanup;
+ }
+
+ // Associate the job to our Printer Handle, but don't set bStartedDoc.
+ // This prevents the caller from doing further StartDocPrinter, WritePrinter, etc. calls on it.
+ pPrinterHandle->pJob = pJob;
}
// Return the Printer handle through our general handle.
return (dwErrorCode == ERROR_SUCCESS);
}
-DWORD WINAPI
-LocalStartDocPrinter(HANDLE hPrinter, DWORD Level, LPBYTE pDocInfo)
+BOOL WINAPI
+LocalReadPrinter(HANDLE hPrinter, PVOID pBuf, DWORD cbBuf, PDWORD pNoBytesRead)
{
+ BOOL bReturnValue;
DWORD dwErrorCode;
- DWORD dwReturnValue = 0;
- PDOC_INFO_1W pDocumentInfo1;
- PLOCAL_HANDLE pHandle;
- PLOCAL_JOB pJob;
+ PLOCAL_HANDLE pHandle = (PLOCAL_HANDLE)hPrinter;
+ PLOCAL_PORT_HANDLE pPortHandle;
PLOCAL_PRINTER_HANDLE pPrinterHandle;
- // Sanity checks
- if (!pDocInfo)
+ // Sanity checks.
+ if (!pHandle)
{
- dwErrorCode = ERROR_INVALID_PARAMETER;
+ dwErrorCode = ERROR_INVALID_HANDLE;
goto Cleanup;
}
- if (!hPrinter)
+ // Port handles are an entirely different thing.
+ if (pHandle->HandleType == HandleType_Port)
{
- dwErrorCode = ERROR_INVALID_HANDLE;
+ pPortHandle = (PLOCAL_PORT_HANDLE)pHandle->pSpecificHandle;
+
+ // Call the monitor's ReadPort function.
+ if (pPortHandle->pPort->pPrintMonitor->bIsLevel2)
+ bReturnValue = ((PMONITOR2)pPortHandle->pPort->pPrintMonitor->pMonitor)->pfnReadPort(pPortHandle->hPort, pBuf, cbBuf, pNoBytesRead);
+ else
+ bReturnValue = ((LPMONITOREX)pPortHandle->pPort->pPrintMonitor->pMonitor)->Monitor.pfnReadPort(pPortHandle->hPort, pBuf, cbBuf, pNoBytesRead);
+
+ if (!bReturnValue)
+ {
+ // The ReadPort function failed. Return its last error.
+ dwErrorCode = GetLastError();
+ goto Cleanup;
+ }
+
+ // We were successful!
+ dwErrorCode = ERROR_SUCCESS;
goto Cleanup;
}
- // Check if this is a printer handle.
- pHandle = (PLOCAL_HANDLE)hPrinter;
+ // The remaining function deals with Printer handles only.
if (pHandle->HandleType != HandleType_Printer)
{
dwErrorCode = ERROR_INVALID_HANDLE;
pPrinterHandle = (PLOCAL_PRINTER_HANDLE)pHandle->pSpecificHandle;
- // Check if this is the right document information level.
- if (Level != 1)
+ // ReadPrinter needs an opened SPL file to work.
+ // This only works if a Printer Job Handle was requested in OpenPrinter.
+ if (pPrinterHandle->hSPLFile == INVALID_HANDLE_VALUE)
{
- dwErrorCode = ERROR_INVALID_LEVEL;
+ dwErrorCode = ERROR_INVALID_HANDLE;
goto Cleanup;
}
- pDocumentInfo1 = (PDOC_INFO_1W)pDocInfo;
+ // Pass the parameters to ReadFile.
+ if (!ReadFile(pPrinterHandle->hSPLFile, pBuf, cbBuf, pNoBytesRead, NULL))
+ {
+ dwErrorCode = GetLastError();
+ ERR("ReadFile failed with error %lu!\n", dwErrorCode);
+ goto Cleanup;
+ }
+
+ dwErrorCode = ERROR_SUCCESS;
+
+Cleanup:
+ SetLastError(dwErrorCode);
+ return (dwErrorCode == ERROR_SUCCESS);
+}
- // Create a new job.
- pJob = DllAllocSplMem(sizeof(LOCAL_JOB));
- pJob->pPrinter = pPrinterHandle->pPrinter;
- pJob->dwPriority = DEF_PRIORITY;
+DWORD WINAPI
+LocalStartDocPrinter(HANDLE hPrinter, DWORD Level, PBYTE pDocInfo)
+{
+ BOOL bReturnValue;
+ DWORD dwErrorCode;
+ DWORD dwReturnValue = 0;
+ PDOC_INFO_1W pDocInfo1 = (PDOC_INFO_1W)pDocInfo;
+ PLOCAL_JOB pJob;
+ PLOCAL_HANDLE pHandle = (PLOCAL_HANDLE)hPrinter;
+ PLOCAL_PORT_HANDLE pPortHandle;
+ PLOCAL_PRINTER_HANDLE pPrinterHandle;
- // Check if a datatype was given.
- if (pDocumentInfo1->pDatatype)
+ // Sanity checks.
+ if (!pHandle)
{
- // Use the datatype if it's valid.
- if (!FindDatatype(pJob->pPrintProcessor, pDocumentInfo1->pDatatype))
+ dwErrorCode = ERROR_INVALID_HANDLE;
+ goto Cleanup;
+ }
+
+ // Port handles are an entirely different thing.
+ if (pHandle->HandleType == HandleType_Port)
+ {
+ pPortHandle = (PLOCAL_PORT_HANDLE)pHandle->pSpecificHandle;
+
+ // This call should come from a Print Processor and the job this port is going to print was assigned to us before opening the Print Processor.
+ // Claim it exclusively for this port handle.
+ pJob = pPortHandle->pPort->pNextJobToProcess;
+ pPortHandle->pPort->pNextJobToProcess = NULL;
+ ASSERT(pJob);
+
+ // Call the monitor's StartDocPort function.
+ if (pPortHandle->pPort->pPrintMonitor->bIsLevel2)
+ bReturnValue = ((PMONITOR2)pPortHandle->pPort->pPrintMonitor->pMonitor)->pfnStartDocPort(pPortHandle->hPort, pJob->pPrinter->pwszPrinterName, pJob->dwJobID, Level, pDocInfo);
+ else
+ bReturnValue = ((LPMONITOREX)pPortHandle->pPort->pPrintMonitor->pMonitor)->Monitor.pfnStartDocPort(pPortHandle->hPort, pJob->pPrinter->pwszPrinterName, pJob->dwJobID, Level, pDocInfo);
+
+ if (!bReturnValue)
{
- dwErrorCode = ERROR_INVALID_DATATYPE;
+ // The StartDocPort function failed. Return its last error.
+ dwErrorCode = GetLastError();
goto Cleanup;
}
- pJob->pwszDatatype = AllocSplStr(pDocumentInfo1->pDatatype);
+ // We were successful!
+ dwErrorCode = ERROR_SUCCESS;
+ dwReturnValue = pJob->dwJobID;
+ goto Cleanup;
}
- else
+
+ // The remaining function deals with Printer handles only.
+ if (pHandle->HandleType != HandleType_Printer)
{
- // Use the printer handle datatype.
- pJob->pwszDatatype = AllocSplStr(pPrinterHandle->pwszDatatype);
+ dwErrorCode = ERROR_INVALID_HANDLE;
+ goto Cleanup;
}
- // Copy over printer defaults.
- pJob->pDevMode = DuplicateDevMode(pPrinterHandle->pDevMode);
+ if (!pDocInfo1)
+ {
+ dwErrorCode = ERROR_INVALID_PARAMETER;
+ goto Cleanup;
+ }
- // Copy over supplied information.
- if (pDocumentInfo1->pDocName)
- pJob->pwszDocumentName = AllocSplStr(pDocumentInfo1->pDocName);
+ pPrinterHandle = (PLOCAL_PRINTER_HANDLE)pHandle->pSpecificHandle;
- if (pDocumentInfo1->pOutputFile)
- pJob->pwszOutputFile = AllocSplStr(pDocumentInfo1->pOutputFile);
+ // pJob may already be occupied if this is a Print Job handle. In this case, StartDocPrinter has to fail.
+ if (pPrinterHandle->pJob)
+ {
+ dwErrorCode = ERROR_INVALID_PARAMETER;
+ goto Cleanup;
+ }
- // Get an ID for the new job.
- if (!GetNextJobID(&pJob->dwJobID))
+ // Check the validity of the datatype if we got one.
+ if (pDocInfo1->pDatatype && !FindDatatype(pPrinterHandle->pJob->pPrintProcessor, pDocInfo1->pDatatype))
{
- dwErrorCode = ERROR_NOT_ENOUGH_MEMORY;
+ dwErrorCode = ERROR_INVALID_DATATYPE;
+ goto Cleanup;
+ }
+
+ // Check if this is the right document information level.
+ if (Level != 1)
+ {
+ dwErrorCode = ERROR_INVALID_LEVEL;
goto Cleanup;
}
- // Add the job to the Global Job List.
- if (!InsertElementSkiplist(&GlobalJobList, pJob))
+ // All requirements are met - create a new job.
+ dwErrorCode = CreateJob(pPrinterHandle);
+ if (dwErrorCode != ERROR_SUCCESS)
+ goto Cleanup;
+
+ // Use any given datatype.
+ if (pDocInfo1->pDatatype && !ReallocSplStr(&pPrinterHandle->pJob->pwszDatatype, pDocInfo1->pDatatype))
{
dwErrorCode = ERROR_NOT_ENOUGH_MEMORY;
- ERR("InsertElementSkiplist failed for job %lu for the GlobalJobList!\n", pJob->dwJobID);
+ ERR("ReallocSplStr failed, last error is %lu!\n", GetLastError());
goto Cleanup;
}
- // Add the job at the end of the Printer's Job List.
- // As all new jobs are created with default priority, we can be sure that it would always be inserted at the end.
- if (!InsertTailElementSkiplist(&pJob->pPrinter->JobList, pJob))
+ // Use any given document name.
+ if (pDocInfo1->pDocName && !ReallocSplStr(&pPrinterHandle->pJob->pwszDocumentName, pDocInfo1->pDocName))
{
dwErrorCode = ERROR_NOT_ENOUGH_MEMORY;
- ERR("InsertTailElementSkiplist failed for job %lu for the Printer's Job List!\n", pJob->dwJobID);
+ ERR("ReallocSplStr failed, last error is %lu!\n", GetLastError());
goto Cleanup;
}
- pPrinterHandle->pStartedJob = pJob;
+ // We were successful!
dwErrorCode = ERROR_SUCCESS;
- dwReturnValue = pJob->dwJobID;
+ dwReturnValue = pPrinterHandle->pJob->dwJobID;
Cleanup:
SetLastError(dwErrorCode);
BOOL WINAPI
LocalStartPagePrinter(HANDLE hPrinter)
{
- ///////////// TODO /////////////////////
- return FALSE;
+ DWORD dwErrorCode;
+ PLOCAL_HANDLE pHandle = (PLOCAL_HANDLE)hPrinter;
+ PLOCAL_PRINTER_HANDLE pPrinterHandle;
+
+ // Sanity checks.
+ if (!pHandle || pHandle->HandleType != HandleType_Printer)
+ {
+ dwErrorCode = ERROR_INVALID_HANDLE;
+ goto Cleanup;
+ }
+
+ pPrinterHandle = (PLOCAL_PRINTER_HANDLE)pHandle->pSpecificHandle;
+
+ // We require StartDocPrinter or AddJob to be called first.
+ if (!pPrinterHandle->bStartedDoc)
+ {
+ dwErrorCode = ERROR_SPL_NO_STARTDOC;
+ goto Cleanup;
+ }
+
+ // Increase the page count.
+ ++pPrinterHandle->pJob->dwTotalPages;
+ dwErrorCode = ERROR_SUCCESS;
+
+Cleanup:
+ SetLastError(dwErrorCode);
+ return (dwErrorCode == ERROR_SUCCESS);
}
BOOL WINAPI
-LocalWritePrinter(HANDLE hPrinter, LPVOID pBuf, DWORD cbBuf, LPDWORD pcWritten)
+LocalWritePrinter(HANDLE hPrinter, PVOID pBuf, DWORD cbBuf, PDWORD pcWritten)
{
- ///////////// TODO /////////////////////
- return FALSE;
+ BOOL bReturnValue;
+ DWORD dwErrorCode;
+ PLOCAL_HANDLE pHandle = (PLOCAL_HANDLE)hPrinter;
+ PLOCAL_PORT_HANDLE pPortHandle;
+ PLOCAL_PRINTER_HANDLE pPrinterHandle;
+
+ // Sanity checks.
+ if (!pHandle)
+ {
+ dwErrorCode = ERROR_INVALID_HANDLE;
+ goto Cleanup;
+ }
+
+ // Port handles are an entirely different thing.
+ if (pHandle->HandleType == HandleType_Port)
+ {
+ pPortHandle = (PLOCAL_PORT_HANDLE)pHandle->pSpecificHandle;
+
+ // Call the monitor's WritePort function.
+ if (pPortHandle->pPort->pPrintMonitor->bIsLevel2)
+ bReturnValue = ((PMONITOR2)pPortHandle->pPort->pPrintMonitor->pMonitor)->pfnWritePort(pPortHandle->hPort, pBuf, cbBuf, pcWritten);
+ else
+ bReturnValue = ((LPMONITOREX)pPortHandle->pPort->pPrintMonitor->pMonitor)->Monitor.pfnWritePort(pPortHandle->hPort, pBuf, cbBuf, pcWritten);
+
+ if (!bReturnValue)
+ {
+ // The WritePort function failed. Return its last error.
+ dwErrorCode = GetLastError();
+ goto Cleanup;
+ }
+
+ // We were successful!
+ dwErrorCode = ERROR_SUCCESS;
+ goto Cleanup;
+ }
+
+ // The remaining function deals with Printer handles only.
+ if (pHandle->HandleType != HandleType_Printer)
+ {
+ dwErrorCode = ERROR_INVALID_HANDLE;
+ goto Cleanup;
+ }
+
+ pPrinterHandle = (PLOCAL_PRINTER_HANDLE)pHandle->pSpecificHandle;
+
+ // We require StartDocPrinter or AddJob to be called first.
+ if (!pPrinterHandle->bStartedDoc)
+ {
+ dwErrorCode = ERROR_SPL_NO_STARTDOC;
+ goto Cleanup;
+ }
+
+ // TODO: This function is only called when doing non-spooled printing.
+ // This needs to be investigated further. We can't just use pPrinterHandle->hSPLFile here, because that's currently reserved for Printer Job handles (see LocalReadPrinter).
+#if 0
+ // Pass the parameters to WriteFile.
+ if (!WriteFile(SOME_SPOOL_FILE_HANDLE, pBuf, cbBuf, pcWritten, NULL))
+ {
+ dwErrorCode = GetLastError();
+ ERR("WriteFile failed with error %lu!\n", GetLastError());
+ goto Cleanup;
+ }
+#endif
+
+ dwErrorCode = ERROR_SUCCESS;
+
+Cleanup:
+ SetLastError(dwErrorCode);
+ return (dwErrorCode == ERROR_SUCCESS);
}
BOOL WINAPI
LocalEndPagePrinter(HANDLE hPrinter)
{
- ///////////// TODO /////////////////////
- return FALSE;
+ DWORD dwErrorCode;
+ PLOCAL_HANDLE pHandle = (PLOCAL_HANDLE)hPrinter;
+
+ // Sanity checks.
+ if (!pHandle || pHandle->HandleType != HandleType_Printer)
+ {
+ dwErrorCode = ERROR_INVALID_HANDLE;
+ goto Cleanup;
+ }
+
+ // This function doesn't do anything else for now.
+ dwErrorCode = ERROR_SUCCESS;
+
+Cleanup:
+ SetLastError(dwErrorCode);
+ return (dwErrorCode == ERROR_SUCCESS);
}
BOOL WINAPI
LocalEndDocPrinter(HANDLE hPrinter)
{
- ///////////// TODO /////////////////////
- return FALSE;
+ BOOL bReturnValue;
+ DWORD dwErrorCode;
+ PLOCAL_HANDLE pHandle = (PLOCAL_HANDLE)hPrinter;
+ PLOCAL_PORT_HANDLE pPortHandle;
+ PLOCAL_PRINTER_HANDLE pPrinterHandle;
+
+ // Sanity checks.
+ if (!pHandle)
+ {
+ dwErrorCode = ERROR_INVALID_HANDLE;
+ goto Cleanup;
+ }
+
+ // Port handles are an entirely different thing.
+ if (pHandle->HandleType == HandleType_Port)
+ {
+ pPortHandle = (PLOCAL_PORT_HANDLE)pHandle->pSpecificHandle;
+
+ // Call the monitor's EndDocPort function.
+ if (pPortHandle->pPort->pPrintMonitor->bIsLevel2)
+ bReturnValue = ((PMONITOR2)pPortHandle->pPort->pPrintMonitor->pMonitor)->pfnEndDocPort(pPortHandle->hPort);
+ else
+ bReturnValue = ((LPMONITOREX)pPortHandle->pPort->pPrintMonitor->pMonitor)->Monitor.pfnEndDocPort(pPortHandle->hPort);
+
+ if (!bReturnValue)
+ {
+ // The EndDocPort function failed. Return its last error.
+ dwErrorCode = GetLastError();
+ goto Cleanup;
+ }
+
+ // We were successful!
+ dwErrorCode = ERROR_SUCCESS;
+ goto Cleanup;
+ }
+
+ // The remaining function deals with Printer handles only.
+ if (pHandle->HandleType != HandleType_Printer)
+ {
+ dwErrorCode = ERROR_INVALID_HANDLE;
+ goto Cleanup;
+ }
+
+ pPrinterHandle = (PLOCAL_PRINTER_HANDLE)pHandle->pSpecificHandle;
+
+ // We require StartDocPrinter or AddJob to be called first.
+ if (!pPrinterHandle->bStartedDoc)
+ {
+ dwErrorCode = ERROR_SPL_NO_STARTDOC;
+ goto Cleanup;
+ }
+
+ // TODO: Something like ScheduleJob
+
+ // Finish the job.
+ pPrinterHandle->bStartedDoc = FALSE;
+ pPrinterHandle->pJob = NULL;
+ dwErrorCode = ERROR_SUCCESS;
+
+Cleanup:
+ SetLastError(dwErrorCode);
+ return (dwErrorCode == ERROR_SUCCESS);
}
BOOL WINAPI
LocalClosePrinter(HANDLE hPrinter)
{
- PLOCAL_HANDLE pHandle;
+ PLOCAL_HANDLE pHandle = (PLOCAL_HANDLE)hPrinter;
+ PLOCAL_PORT_HANDLE pPortHandle;
+ PLOCAL_PRINTER_HANDLE pPrinterHandle;
+ PLOCAL_XCV_HANDLE pXcvHandle;
- if (!hPrinter)
+ if (!pHandle)
{
SetLastError(ERROR_INVALID_HANDLE);
return FALSE;
}
- pHandle = (PLOCAL_HANDLE)hPrinter;
+ if (pHandle->HandleType == HandleType_Port)
+ {
+ pPortHandle = (PLOCAL_PORT_HANDLE)pHandle->pSpecificHandle;
+
+ // Call the monitor's ClosePort function.
+ if (pPortHandle->pPort->pPrintMonitor->bIsLevel2)
+ ((PMONITOR2)pPortHandle->pPort->pPrintMonitor->pMonitor)->pfnClosePort(pPortHandle->hPort);
+ else
+ ((LPMONITOREX)pPortHandle->pPort->pPrintMonitor->pMonitor)->Monitor.pfnClosePort(pPortHandle->hPort);
+ }
+ else if (pHandle->HandleType == HandleType_Printer)
+ {
+ pPrinterHandle = (PLOCAL_PRINTER_HANDLE)pHandle->pSpecificHandle;
+
+ // Terminate any started job.
+ if (pPrinterHandle->pJob)
+ FreeJob(pPrinterHandle->pJob);
- ///////////// TODO /////////////////////
- /// Check the handle type, do thoroughful checks on all data fields and clean them.
- ////////////////////////////////////////
+ // Free memory for the fields.
+ DllFreeSplMem(pPrinterHandle->pDevMode);
+ DllFreeSplStr(pPrinterHandle->pwszDatatype);
+ }
+ else if (pHandle->HandleType == HandleType_Xcv)
+ {
+ pXcvHandle = (PLOCAL_XCV_HANDLE)pHandle->pSpecificHandle;
+
+ // Call the monitor's XcvClosePort function.
+ if (pXcvHandle->pPrintMonitor->bIsLevel2)
+ ((PMONITOR2)pXcvHandle->pPrintMonitor->pMonitor)->pfnXcvClosePort(pXcvHandle->hXcv);
+ else
+ ((LPMONITOREX)pXcvHandle->pPrintMonitor->pMonitor)->Monitor.pfnXcvClosePort(pXcvHandle->hXcv);
+ }
+ // Free memory for the handle and the specific handle.
+ DllFreeSplMem(pHandle->pSpecificHandle);
DllFreeSplMem(pHandle);
return TRUE;
projects / reactos.git / blobdiff