Changeset 13 for rxprtutl/trunk/rxprtutl.c

Timestamp:

May 2, 2013, 3:35:06 PM (12 years ago)

Author:

Alex Taylor

Message:

Added RPUPortQuery function, improved discussion of port driver settings in 'notes'.

File:

• rxprtutl/trunk/rxprtutl.c (modified) (13 diffs)

rxprtutl/trunk/rxprtutl.c ¶

@@ -60 +60 @@
 #define SZ_LIBRARY_NAME         "RXPRTUTL"  // Name of this library
 #define SZ_ERROR_NAME           "RPUERROR"  // REXX variable used to store error codes
-#define SZ_VERSION              "0.2.1"     // Current version of this library
+#define SZ_VERSION              "0.2.2"     // Current version of this library
 
 #define APPNAME_LEAD_STR        "PM_"
@@ -73 +73 @@
 
 // Values that should be defined in pmsplb.h if it actually existed
+#define TYPE_SHORT_WAIT         1
 #define TYPE_LONG_WAIT          2
 #define BIDI_SET_PORTDRV        0x19
+#define BIDI_Q_PORTDRV          0x8019
 
 // Values used by WinOpenObject
@@ -131 +133 @@
     "RPUPortDialog",
     "RPUPortInstall",
+    "RPUPortQuery",
     "RPUPortSet",
     "RPUPrinterCreate",
@@ -153 +156 @@
 RexxFunctionHandler RPUPortDialog;
 RexxFunctionHandler RPUPortInstall;
+RexxFunctionHandler RPUPortQuery;
 RexxFunctionHandler RPUPortSet;
 RexxFunctionHandler RPUPrinterCreate;
@@ -168 +172 @@
 ULONG   UniqueDeviceName( PSZ pszName );
 BOOL    WriteCompoundVariable( PSZ pszStem, PSZ pszTail, PSZ pszValue );
+BOOL    WriteSimpleVariable( PSZ pszName, PSZ pszValue );
 BOOL    WriteStemElement( PSZ pszStem, ULONG ulIndex, PSZ pszValue );
 void    WriteErrorCode( ULONG ulError, PSZ pszContext );
@@ -523 +528 @@
     PSZ          pszToken;
     HOBJECT      hObj;                  // printer WPS object handle
+
+    /* Note: SPL_PR_LOCAL_ONLY apparently doesn't prevent SplEnumPrinter from
+     *       including remote printers, it only stops it from probing them
+     *       to query the remote queue information in addition to the local
+     *       queue.  Specifying it here prevents a 'stall' when the remote
+     *       host is offline or unavailable.
+     */
     ULONG        flType     = SPL_PR_QUEUE | SPL_PR_DIRECT_DEVICE | SPL_PR_LOCAL_ONLY,
                  cbBuf      = 0,
@@ -620 +632 @@
              * of the print device(s) connected to it.
              */
-
-#if 0
-            if ( pPInfo->pszComputerName ) {
-                /* Network printer.  Just display the local information and
-                 * don't try to query the remote queue.
-                 */
-                sprintf( szStemNode, "%s.%u", szStem, ++ulCount );
-                WriteCompoundVariable( szStemNode, "!name",
-                                       pPInfo->pszPrintDestinationName );
-                WriteCompoundVariable( szStemNode, "!description",
-                                       pPInfo->pszDescription );
-                WriteCompoundVariable( szStemNode, "!queue",
-                                       pPInfo->pszPrintDestinationName);
-                WriteCompoundVariable( szStemNode, "!flags", "");
-                WriteCompoundVariable( szStemNode, "!handle", "");
-                WriteCompoundVariable( szStemNode, "!host",
-                                       pPInfo->pszComputerName );
-                continue;
-            }
-#endif
-
             rc = SplQueryQueue( pPInfo->pszComputerName,
                                 pPInfo->pszPrintDestinationName,
@@ -787 +778 @@
  *      installed and registered in OS2.INI already.         (REQUIRED)      *
  *   2. The name of the new port to be created.  If not specified, the port  *
- *      driver will be responsible for using a default name. (DEFAULT: none) *
+ *      driver will be responsible for using a default name.  This should    *
+ *      generally be specified, as the driver is not guaranteed to support   *
+ *      omitting it.                                         (DEFAULT: none) *
  *                                                                           *
  * REXX RETURN VALUE:                                                        *
@@ -857 +850 @@
         WriteErrorCode( rc, "SplPdInstallPort");
         MAKERXSTRING( *prsResult, "0", 1 );
+    }
+
+finish:
+    DosFreeModule( hPdr );
+cleanup:
+    WinTerminate( hab );
+    return ( 0 );
+}
+
+
+/* ------------------------------------------------------------------------- *
+ * RPUPortQuery                                                              *
+ *                                                                           *
+ * Queries the specified port's configuration settings.  IMPORTANT: not all  *
+ * port drivers support this; the standard OS/2 serial and parallel port     *
+ * drivers do NOT.  When this API is not supported, the return value should  *
+ * be ''.  Otherwise, the format of the returned configuration data is a     *
+ * string of binary data in port driver-specific format (the caller assumes  *
+ * responsibility for knowing how to interpret it).                          *
+ *                                                                           *
+ * REXX ARGUMENTS:                                                           *
+ *   1. The name of the port driver without any extension.  This must be     *
+ *      installed and registered in OS2.INI already.              (REQUIRED) *
+ *   2. The name of the port to be queried.                       (REQUIRED) *
+ *                                                                           *
+ * REXX RETURN VALUE:                                                        *
+ *   Binary data representing the port configuration, in whatever format is  *
+ *   returned by the driver's SplPdQuery->BIDI_Q_PORTDRV routine.  This      *
+ *   depends on the particular port driver; consult its API documentation.   *
+ *   '' will be returned if an error occurred.                               *
+ * ------------------------------------------------------------------------- */
+ULONG APIENTRY RPUPortQuery( PSZ pszName, ULONG argc, RXSTRING argv[], PSZ pszQueue, PRXSTRING prsResult )
+{
+    HAB     hab;                        // desktop anchor-block handle
+    HMODULE hPdr = NULLHANDLE;          // handle to port driver module
+    PFN     pfnQueryPort;               // pointer to driver's SplPdSet entrypoint
+    ULONG   ulCB,                       // return value from PrfQueryProfileString()
+            cBuf;                       // size of configuration buffer
+    PSZ     pszPdrName  = NULL,         // name of the specified port driver
+            pszPortName = NULL;         // name of the new port to create
+    CHAR    szPathName[ CCHMAXPATH+1 ]; // FQN of the port driver module
+    PBYTE   pBuf;                       // Pointer to configuration buffer
+    APIRET  rc = 0;                     // return code from Dos...() functions
+
+
+    // Reset the error indicator
+    WriteErrorCode( 0, NULL );
+
+    // Make sure we have exactly two valid arguments
+    if ( argc != 2 ||
+         !RXVALIDSTRING( argv[0] ) ||
+         !RXVALIDSTRING( argv[1] ))
+        return ( 40 );
+    pszPdrName  = strupr( argv[0].strptr );
+    pszPortName = strupr( argv[1].strptr );
+
+    // Get the path to the installed port driver
+    hab = WinInitialize( 0 );
+    if ( !hab ) {
+        WriteErrorCode( 0, "WinInitialize");
+        MAKERXSTRING( *prsResult, "", 0 );
+        return ( 0 );
+    }
+
+    ulCB = PrfQueryProfileString( HINI_SYSTEMPROFILE, APPNAME_PM_PORT_DRIVER,
+                                  pszPdrName, NULL, (PVOID) szPathName, CCHMAXPATH );
+    if ( !ulCB ) {
+        WriteErrorCode( ERRORIDERROR( WinGetLastError( hab )), "PrfQueryProfileString");
+        MAKERXSTRING( *prsResult, "", 0 );
+        goto cleanup;
+    }
+
+    // Load the port driver DLL and register its query routine
+    rc = DosLoadModule( NULL, 0, szPathName, &hPdr );
+    if ( rc != NO_ERROR || !hPdr ) {
+        WriteErrorCode( rc, "DosLoadModule");
+        MAKERXSTRING( *prsResult, "", 0 );
+        goto cleanup;
+    }
+    rc = DosQueryProcAddr( hPdr, 0, "SPLPDQUERY", &pfnQueryPort );
+    if ( rc != NO_ERROR ) {
+        WriteErrorCode( rc, "DosQueryProcAddr");
+        MAKERXSTRING( *prsResult, "", 0 );
+        goto finish;
+    }
+
+    // Now get the port configuration
+    rc = pfnQueryPort( pszPortName, TYPE_SHORT_WAIT, BIDI_Q_PORTDRV, NULL, 0, NULL, &cBuf );
+    if ( cBuf && ( rc == NO_ERROR ) ||
+                 ( rc == ERROR_MORE_DATA ) || ( rc == NERR_BufTooSmall ))
+    {
+        pBuf = (PBYTE) malloc( cBuf );
+        if ( pBuf ) {
+            rc = pfnQueryPort( pszPortName, TYPE_SHORT_WAIT, BIDI_Q_PORTDRV, NULL, 0, pBuf, &cBuf );
+            if ( rc == NO_ERROR ) {
+                // Write the data contents to our return RXSTRING
+                if ( !SaveResultString( prsResult, pBuf, cBuf ))
+                    MAKERXSTRING( *prsResult, "", 0 );
+            }
+            else {
+                WriteErrorCode( rc, "SplPdQuery 2");
+                MAKERXSTRING( *prsResult, "", 0 );
+            }
+            free( pBuf );
+        }
+        else {
+            WriteErrorCode( ERROR_NOT_ENOUGH_MEMORY, "malloc");
+            MAKERXSTRING( *prsResult, "", 0 );
+        }
+    }
+    else {
+        WriteErrorCode( rc, "SplPdQuery 1");
+        MAKERXSTRING( *prsResult, "", 0 );
     }
 
@@ -924 +1030 @@
          !RXVALIDSTRING( argv[2] )  )
         return ( 40 );
-    pszPdrName  = argv[0].strptr;
+    pszPdrName  = strupr( argv[0].strptr );
     pszPortName = strupr( argv[1].strptr );
     pBuf        = argv[2].strptr;
@@ -1014 +1120 @@
          !RXVALIDSTRING( argv[1] )  )
         return ( 40 );
-    pszPdrName  = argv[0].strptr;
+    pszPdrName  = strupr( argv[0].strptr );
     pszPortName = strupr( argv[1].strptr );
 
@@ -1262 +1368 @@
 
     // Try and destroy the WPS object
+    //  - NB This causes a long delay when deleting an offline LAN printer
     if ( hObj != NULLHANDLE ) WinDestroyObject( hObj );
 
@@ -1877 +1984 @@
 
 /* ------------------------------------------------------------------------- *
+ * WriteSimpleVariable                                                       *
+ *                                                                           *
+ * Creates a variable in the calling REXX program using the REXX shared      *
+ * variable pool interface.                                                  *
+ *                                                                           *
+ * ARGUMENTS:                                                                *
+ *   PSZ pszName  : The name of the variable to write.                       *
+ *   PSZ pszValue : The value to write to the variable.                      *
+ *                                                                           *
+ * RETURNS: BOOL                                                             *
+ * ------------------------------------------------------------------------- */
+BOOL WriteSimpleVariable( PSZ pszName, PSZ pszValue )
+{
+    SHVBLOCK shvVar;                   // REXX shared variable pool block
+    ULONG    ulRc;
+    CHAR     szText[ US_COMPOUND_MAXZ ];
+
+    strncpy( szText, pszValue, US_COMPOUND_MAXZ-1 );
+    MAKERXSTRING( shvVar.shvname,  pszName, strlen(pszName) );
+    MAKERXSTRING( shvVar.shvvalue, szText,  strlen(szText) );
+    shvVar.shvnamelen  = RXSTRLEN( shvVar.shvname );
+    shvVar.shvvaluelen = RXSTRLEN( shvVar.shvvalue );
+    shvVar.shvcode     = RXSHV_SYSET;
+    shvVar.shvnext     = NULL;
+    ulRc = RexxVariablePool( &shvVar );
+    if ( ulRc > 1 ) {
+        WriteErrorCode( shvVar.shvret, "RexxVariablePool (SHVBLOCK.shvret)");
+        return FALSE;
+    }
+    return TRUE;
+}
+
+
+/* ------------------------------------------------------------------------- *
  * WriteErrorCode                                                            *
  *                                                                           *