Changeset 8 for rxprtutl/trunk/rxprtutl.c

Timestamp:

Apr 6, 2013, 8:45:22 PM (12 years ago)

Author:

Alex Taylor

Message:

Redesigned RPUCreatePrinter to simplify parameters; device name now generated automatically.

File:

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

rxprtutl/trunk/rxprtutl.c

@@ -88 +88 @@
 #define US_PRTINFO_MAXZ         180                                  // ...of a printer info string
 #define US_PORT_MAXZ            64                                   // ...of a port name
-#define US_SS_MAXZ              256                                  // ...of a default WPS setup string
+#define US_PRTDEV_MAXZ          9                                    // ...of a print device name
 
 // List of functions to be registered by RPULoadFuncs
@@ -138 +138 @@
 HOBJECT PrinterObjectHandle( PSZ pszQueueName );
 BOOL    SaveResultString( PRXSTRING prsResult, PCH pchBytes, ULONG ulBytes );
+ULONG   UniqueDeviceName( PSZ pszName );
 BOOL    WriteCompoundVariable( PSZ pszStem, PSZ pszTail, PSZ pszValue );
 BOOL    WriteStemElement( PSZ pszStem, ULONG ulIndex, PSZ pszValue );
@@ -1013 +1014 @@
  *                                                                           *
  * Creates a new local printer object.  The associated print queue and       *
- * device are also created if they do not exist.  However, the associated    *
- * output port must exist, and the specified printer driver/model must have  *
- * been installed already.                                                   *
- *                                                                           *
- * The WPS object is created with default settings (other than those which   *
- * are specified here).  It will be assigned an object-ID automatically.     *
- *                                                                           *
- * This function will not create a remote (LAN) printer object.              *
+ * device are created automatically.  However, the specified output port     *
+ * must exist, and the specified printer driver/model must have been         *
+ * installed already.                                                        *
+ *                                                                           *
+ * The WPS object is created with default settings, and will be assigned an  *
+ * object-ID automatically by the WPS.                                       *
+ *                                                                           *
+ * NOTE: This function will NOT create a remote (LAN) printer object.        *
  *                                                                           *
  * REXX ARGUMENTS:                                                           *
- *   1. The name of the print queue, to be created if necessary.  (REQUIRED) *
- *   2. The "physical name" of the printer device, ditto.         (REQUIRED) *
+ *   1. The printer description, used as the WPS object title.    (REQUIRED) *
+ *   2. The name of the underlying print queue. Must be a legal              *
+ *      queue name according to OS/2 (but what is that...?)       (REQUIRED) *
  *   3. The name of the printer port, which must exist already.   (REQUIRED) *
  *   4. The default printer driver.model to be associated with               *
- *      the device.  If specified, this must be installed in the             *
- *      system already.  If not specified, and the named printer             *
- *      device does not already exist, IBMNULL will be assumed.   (OPTIONAL) *
- *   5. The printer object title (i.e. human-readable name).  If             *
- *      not specified, the physical name will be used.            (OPTIONAL) *
+ *      the device. If specified, this must be installed in the              *
+ *      system already. If not specified, IBMNULL is assumed.    (OPTIONAL)  *
  *                                                                           *
  * REXX RETURN VALUE:                                                        *
@@ -1040 +1039 @@
     PRDINFO3  devinfo       = {0};
     PRQINFO3  qinfo         = {0};
-    ULONG     cbBuf         = 0;
-    BOOL      fNewD         = FALSE;
     PSZ       pszQueueName  = NULL,
-              pszDeviceName = NULL,
               pszPortName   = NULL,
               pszModel      = NULL,
               pszTitle      = NULL;
+    CHAR      szDevice[ US_PRTDEV_MAXZ ] = {0};
     SPLERR    rc;
 
@@ -1054 +1051 @@
 
     // Validate the REXX arguments
-    if (( argc < 3 ) || ( argc > 5 )  || ( ! RXVALIDSTRING( argv[0] )) ||
+    if (( argc < 3 ) || ( argc > 4 )  || ( ! RXVALIDSTRING( argv[0] )) ||
         ( ! RXVALIDSTRING( argv[1] )) || ( ! RXVALIDSTRING( argv[2] )))
         return ( 40 );
     if (( argc > 3 ) && ( ! RXVALIDSTRING( argv[3] )))
         return ( 40 );
-    if (( argc > 4 ) && ( ! RXVALIDSTRING( argv[4] )))
-        return ( 40 );
-
-    pszQueueName  = argv[0].strptr;
-    pszDeviceName = argv[1].strptr;
+
+    pszTitle      = argv[0].strptr;
+    pszQueueName  = argv[1].strptr;
     pszPortName   = argv[2].strptr;
     if ( argc > 3 ) pszModel = argv[3].strptr;
-    pszTitle = ( argc > 4 ) ? argv[4].strptr : pszDeviceName;
-
-    // Find out if device exists already
-    rc = SplQueryDevice( NULL, pszDeviceName, 0, NULL, 0, &cbBuf );
-    if ( rc == NERR_DestNotFound ) {
-
-        // Nope, create it now
-        devinfo.pszPrinterName = pszDeviceName;
-        devinfo.pszUserName    = NULL;
-        devinfo.pszLogAddr     = pszPortName;
-        devinfo.pszComment     = pszTitle;
-        devinfo.pszDrivers     = pszModel ? pszModel : "IBMNULL";
-        devinfo.usTimeOut      = 45;
-        rc = SplCreateDevice( NULL, 3, &devinfo, sizeof( devinfo ));
-        if ( rc != NO_ERROR ) {
-            WriteErrorCode( rc, "SplCreateDevice");
-            MAKERXSTRING( *prsResult, "0", 1 );
-            return ( 0 );
-        }
-        fNewD = TRUE;
-    }
-    else if ( rc != NO_ERROR ) {
-        WriteErrorCode( rc, "SplQueryDevice");
+
+    // Generate a suitable (unique) device name, based on the queue name
+    strncpy( szDevice, pszQueueName, US_PRTDEV_MAXZ-1 );
+    if (( rc = UniqueDeviceName( szDevice )) != NO_ERROR ) {
+        if ( rc == 1 )      // shouldn't really happen
+            WriteErrorCode( rc, "UniqueDeviceName");
+        else
+            WriteErrorCode( rc, "SplEnumDevice");
         MAKERXSTRING( *prsResult, "0", 1 );
         return ( 0 );
     }
 
-    // Find out if the queue name already exists
-    rc = SplQueryQueue( NULL, pszQueueName, 3, NULL, 0, &cbBuf );
-    if ( rc == NERR_QNotFound ) {
-
-        // Nope, create it now
-        qinfo.pszName       = pszQueueName;
-        qinfo.uPriority     = PRQ_DEF_PRIORITY;
-        qinfo.fsType        = PRQ3_TYPE_RAW;
-        qinfo.pszPrProc     = "PMPRINT";
-        qinfo.pszComment    = pszTitle;
-        qinfo.pszPrinters   = pszDeviceName;
-        qinfo.pszDriverName = pszModel ? pszModel : "IBMNULL";
-        rc = SplCreateQueue( NULL, 3, &qinfo, sizeof( qinfo ));
-        if ( rc != NO_ERROR ) {
-            WriteErrorCode( rc, "SplCreateQueue");
-            MAKERXSTRING( *prsResult, "0", 1 );
-            if ( fNewD ) SplDeleteDevice( NULL, pszDeviceName );
-            return ( 0 );
-        }
-    }
-    else if ( rc != NO_ERROR ) {
-        WriteErrorCode( rc, "SplQueryQueue");
-        MAKERXSTRING( *prsResult, "0", 1 );
-        if ( fNewD ) SplDeleteDevice( NULL, pszDeviceName );
+    // Create the device
+    devinfo.pszPrinterName = szDevice;
+    devinfo.pszUserName    = NULL;
+    devinfo.pszLogAddr     = pszPortName;
+    devinfo.pszComment     = pszTitle;
+    devinfo.pszDrivers     = pszModel ? pszModel : "IBMNULL";
+    devinfo.usTimeOut      = 45;
+    rc = SplCreateDevice( NULL, 3, &devinfo, sizeof( devinfo ));
+    if ( rc != NO_ERROR ) {
+        WriteErrorCode( rc, "SplCreateDevice");
+        MAKERXSTRING( *prsResult, "0", 1 );
+        return ( 0 );
+    }
+
+    // Create the queue (automatically creates printer object)
+    qinfo.pszName       = pszQueueName;
+    qinfo.uPriority     = PRQ_DEF_PRIORITY;
+    qinfo.fsType        = PRQ3_TYPE_RAW;
+    qinfo.pszPrProc     = "PMPRINT";
+    qinfo.pszComment    = pszTitle;
+    qinfo.pszPrinters   = szDevice;
+    qinfo.pszDriverName = pszModel ? pszModel : "IBMNULL";
+    rc = SplCreateQueue( NULL, 3, &qinfo, sizeof( qinfo ));
+    if ( rc != NO_ERROR ) {
+        WriteErrorCode( rc, "SplCreateQueue");
+        MAKERXSTRING( *prsResult, "0", 1 );
+        SplDeleteDevice( NULL, szDevice );
         return ( 0 );
     }
@@ -1507 +1490 @@
 
 
+/* ------------------------------------------------------------------------- *
+ * UniqueDeviceName                                                          *
+ *                                                                           *
+ * Check (and, if necessary, modify) the specified print device name to make *
+ * sure it is unique.                                                        *
+ *                                                                           *
+ * ARGUMENTS:                                                                *
+ *   PSZ pszName : Pointer to device name buffer (9-byte CHAR buffer)        *
+ *                                                                           *
+ * RETURNS: ULONG                                                            *
+ *   0 on success, 1 if no unique name could be generated, or the return     *
+ *   code from SplEnumDevice() if an error occurred.                         *
+ * ------------------------------------------------------------------------- */
+ULONG UniqueDeviceName( PSZ pszName )
+{
+    PBYTE     pBuf;
+    PPRDINFO3 pprd3;
+    CHAR      szNumber[ US_PRTDEV_MAXZ ] = {0};
+    ULONG     i, n, pos,
+              ulNumber  = 0,
+              ulAvail   = 0,
+              cbBuf     = 0;
+    BOOL      fUnique   = FALSE;
+    SPLERR    rc;
+
+
+    rc = SplEnumDevice( NULL, 3, NULL, 0, &ulNumber, &ulAvail, &cbBuf, NULL );
+    if ( rc == ERROR_MORE_DATA || rc == NERR_BufTooSmall ) {
+        pBuf = malloc( cbBuf );
+        if ( pBuf ) {
+            rc = SplEnumDevice( NULL, 3, pBuf, cbBuf, &ulNumber, &ulAvail, &cbBuf, NULL );
+            if ( rc == NO_ERROR ) {
+                n = 1;
+                while ( !fUnique && ( n < 999 )) {     // max 999 as a sanity check
+                    for ( i = 0; i < ulNumber; i++ )  {
+                        pprd3 = (PPRDINFO3) pBuf + i;
+                        if ( stricmp( pszName, pprd3->pszPrinterName ) == 0 ) break;
+                    }
+                    if ( i >= ulNumber ) fUnique = TRUE;
+                    else {
+                        sprintf( szNumber, "%u", n++ );
+                        pos = strlen( pszName ) - strlen( szNumber );
+                        pszName[ pos ] = '\0';
+                        strncat( pszName, szNumber, US_PRTDEV_MAXZ-1 );
+                    }
+                }
+            }
+            free( pBuf );
+        }
+    }
+    if ( rc == NO_ERROR && !fUnique ) return 1;
+    else return rc;
+}
+
+
 /* ************************************************************************* *
  * INTERNAL REXX DLL UTILITY FUNCTIONS                                       *