Automatically trim returned strings

Author: ibmmqmet

ibmmq/mqi.go

@@ -57,6 +57,7 @@ import "C"
 
 import (
 	"encoding/binary"
+	"strings"
 	"unsafe"
 )
 
@@ -110,10 +111,11 @@ func (e *MQReturn) Error() string {
 }
 
 /*
- * Copy a Go string into a fixed-size C char array such as MQCHAR12
+ * Copy a Go string in	"strings"
+to a fixed-size C char array such as MQCHAR12
  * Once the string has been copied, it can be immediately freed
  * Empty strings have first char set to 0 in MQI structures
- */
+*/
 func setMQIString(a *C.char, v string, l int) {
 	if len(v) > 0 {
 		p := C.CString(v)
@@ -124,6 +126,23 @@ func setMQIString(a *C.char, v string, l int) {
 	}
 }
 
+/*
+ * The C,GoStringN function can return strings that include
+ * NUL characters (which is not really what is expected for a C string-related
+ * function). So we have a utility function to remove any trailing nulls
+ */
+func trimStringN(c *C.char, l C.int) string {
+	var rc string
+	s := C.GoStringN(c, l)
+	i := strings.IndexByte(s, 0)
+	if i == -1 {
+		rc = s
+	} else {
+		rc = s[0:i]
+	}
+	return rc
+}
+
 /*
 Conn is the function to connect to a queue manager
 */
@@ -242,6 +261,9 @@ func (x *MQQueueManager) Open(good *MQOD, goOpenOptions int32) (MQObject, error)
 
 	// ObjectName may have changed because it's a model queue
 	object.Name = good.ObjectName
+	if good.ObjectType == C.MQOT_TOPIC {
+		object.Name = good.ObjectString
+	}
 
 	return object, nil
 

ibmmq/mqiMQGMO.go

@@ -107,7 +107,7 @@ func copyGMOfromC(mqgmo *C.MQGMO, gogmo *MQGMO) {
 	gogmo.WaitInterval = int32(mqgmo.WaitInterval)
 	gogmo.Signal1 = int32(mqgmo.Signal1)
 	gogmo.Signal2 = int32(mqgmo.Signal2)
-	gogmo.ResolvedQName = C.GoStringN((*C.char)(&mqgmo.ResolvedQName[0]), C.MQ_OBJECT_NAME_LENGTH)
+	gogmo.ResolvedQName = trimStringN((*C.char)(&mqgmo.ResolvedQName[0]), C.MQ_OBJECT_NAME_LENGTH)
 	gogmo.MatchOptions = int32(mqgmo.MatchOptions)
 	gogmo.GroupStatus = rune(mqgmo.GroupStatus)
 	gogmo.SegmentStatus = rune(mqgmo.SegmentStatus)

ibmmq/mqiMQMD.go

@@ -159,7 +159,7 @@ func copyMDfromC(mqmd *C.MQMD, gomd *MQMD) {
 	gomd.Feedback = int32(mqmd.Feedback)
 	gomd.Encoding = int32(mqmd.Encoding)
 	gomd.CodedCharSetId = int32(mqmd.CodedCharSetId)
-	gomd.Format = C.GoStringN((*C.char)(&mqmd.Format[0]), C.MQ_FORMAT_LENGTH)
+	gomd.Format = trimStringN((*C.char)(&mqmd.Format[0]), C.MQ_FORMAT_LENGTH)
 	gomd.Priority = int32(mqmd.Priority)
 	gomd.Persistence = int32(mqmd.Persistence)
 
@@ -171,19 +171,19 @@ func copyMDfromC(mqmd *C.MQMD, gomd *MQMD) {
 	}
 	gomd.BackoutCount = int32(mqmd.BackoutCount)
 
-	gomd.ReplyToQ = C.GoStringN((*C.char)(&mqmd.ReplyToQ[0]), C.MQ_OBJECT_NAME_LENGTH)
-	gomd.ReplyToQMgr = C.GoStringN((*C.char)(&mqmd.ReplyToQMgr[0]), C.MQ_OBJECT_NAME_LENGTH)
+	gomd.ReplyToQ = trimStringN((*C.char)(&mqmd.ReplyToQ[0]), C.MQ_OBJECT_NAME_LENGTH)
+	gomd.ReplyToQMgr = trimStringN((*C.char)(&mqmd.ReplyToQMgr[0]), C.MQ_OBJECT_NAME_LENGTH)
 
-	gomd.UserIdentifier = C.GoStringN((*C.char)(&mqmd.UserIdentifier[0]), C.MQ_USER_ID_LENGTH)
+	gomd.UserIdentifier = trimStringN((*C.char)(&mqmd.UserIdentifier[0]), C.MQ_USER_ID_LENGTH)
 	for i = 0; i < C.MQ_ACCOUNTING_TOKEN_LENGTH; i++ {
 		gomd.AccountingToken[i] = (byte)(mqmd.AccountingToken[i])
 	}
-	gomd.ApplIdentityData = C.GoStringN((*C.char)(&mqmd.ApplIdentityData[0]), C.MQ_APPL_IDENTITY_DATA_LENGTH)
+	gomd.ApplIdentityData = trimStringN((*C.char)(&mqmd.ApplIdentityData[0]), C.MQ_APPL_IDENTITY_DATA_LENGTH)
 	gomd.PutApplType = int32(mqmd.PutApplType)
-	gomd.PutApplName = C.GoStringN((*C.char)(&mqmd.PutApplName[0]), C.MQ_PUT_APPL_NAME_LENGTH)
-	gomd.PutDate = C.GoStringN((*C.char)(&mqmd.PutDate[0]), C.MQ_PUT_DATE_LENGTH)
-	gomd.PutTime = C.GoStringN((*C.char)(&mqmd.PutTime[0]), C.MQ_PUT_TIME_LENGTH)
-	gomd.ApplOriginData = C.GoStringN((*C.char)(&mqmd.ApplOriginData[0]), C.MQ_APPL_ORIGIN_DATA_LENGTH)
+	gomd.PutApplName = trimStringN((*C.char)(&mqmd.PutApplName[0]), C.MQ_PUT_APPL_NAME_LENGTH)
+	gomd.PutDate = trimStringN((*C.char)(&mqmd.PutDate[0]), C.MQ_PUT_DATE_LENGTH)
+	gomd.PutTime = trimStringN((*C.char)(&mqmd.PutTime[0]), C.MQ_PUT_TIME_LENGTH)
+	gomd.ApplOriginData = trimStringN((*C.char)(&mqmd.ApplOriginData[0]), C.MQ_APPL_ORIGIN_DATA_LENGTH)
 
 	for i = 0; i < C.MQ_GROUP_ID_LENGTH; i++ {
 		gomd.GroupId[i] = (byte)(mqmd.GroupId[i])

ibmmq/mqiMQOD.go

@@ -179,10 +179,11 @@ func copyODfromC(mqod *C.MQOD, good *MQOD) {
 
 	good.Version = int32(mqod.Version)
 	good.ObjectType = int32(mqod.ObjectType)
-	good.ObjectName = C.GoStringN((*C.char)(&mqod.ObjectName[0]), C.MQ_OBJECT_NAME_LENGTH)
-	good.ObjectQMgrName = C.GoStringN((*C.char)(&mqod.ObjectQMgrName[0]), C.MQ_OBJECT_NAME_LENGTH)
-	good.DynamicQName = C.GoStringN((*C.char)(&mqod.DynamicQName[0]), C.MQ_OBJECT_NAME_LENGTH)
-	good.AlternateUserId = C.GoStringN((*C.char)(&mqod.AlternateUserId[0]), C.MQ_USER_ID_LENGTH)
+	good.ObjectName = trimStringN((*C.char)(&mqod.ObjectName[0]), C.MQ_OBJECT_NAME_LENGTH)
+
+	good.ObjectQMgrName = trimStringN((*C.char)(&mqod.ObjectQMgrName[0]), C.MQ_OBJECT_NAME_LENGTH)
+	good.DynamicQName = trimStringN((*C.char)(&mqod.DynamicQName[0]), C.MQ_OBJECT_NAME_LENGTH)
+	good.AlternateUserId = trimStringN((*C.char)(&mqod.AlternateUserId[0]), C.MQ_USER_ID_LENGTH)
 
 	good.RecsPresent = int32(mqod.RecsPresent)
 	good.KnownDestCount = int32(mqod.KnownDestCount)
@@ -198,14 +199,14 @@ func copyODfromC(mqod *C.MQOD, good *MQOD) {
 		good.AlternateSecurityId[i] = (byte)(mqod.AlternateSecurityId[i])
 	}
 
-	good.ResolvedQName = C.GoStringN((*C.char)(&mqod.ResolvedQName[0]), C.MQ_OBJECT_NAME_LENGTH)
-	good.ResolvedQMgrName = C.GoStringN((*C.char)(&mqod.ResolvedQMgrName[0]), C.MQ_OBJECT_NAME_LENGTH)
+	good.ResolvedQName = trimStringN((*C.char)(&mqod.ResolvedQName[0]), C.MQ_OBJECT_NAME_LENGTH)
+	good.ResolvedQMgrName = trimStringN((*C.char)(&mqod.ResolvedQMgrName[0]), C.MQ_OBJECT_NAME_LENGTH)
 
-	good.ObjectString = C.GoStringN((*C.char)(mqod.ObjectString.VSPtr), (C.int)(mqod.ObjectString.VSLength))
+	good.ObjectString = trimStringN((*C.char)(mqod.ObjectString.VSPtr), (C.int)(mqod.ObjectString.VSLength))
 	C.free(unsafe.Pointer(mqod.ObjectString.VSPtr))
-	good.SelectionString = C.GoStringN((*C.char)(mqod.SelectionString.VSPtr), (C.int)(mqod.SelectionString.VSLength))
+	good.SelectionString = trimStringN((*C.char)(mqod.SelectionString.VSPtr), (C.int)(mqod.SelectionString.VSLength))
 	C.free(unsafe.Pointer(mqod.SelectionString.VSPtr))
-	good.ResObjectString = C.GoStringN((*C.char)(mqod.ResObjectString.VSPtr), (C.int)(mqod.ResObjectString.VSLength))
+	good.ResObjectString = trimStringN((*C.char)(mqod.ResObjectString.VSPtr), (C.int)(mqod.ResObjectString.VSLength))
 	C.free(unsafe.Pointer(mqod.ResObjectString.VSPtr))
 	good.ResolvedType = int32(mqod.ResolvedType)
 

ibmmq/mqiMQPMO.go

@@ -126,8 +126,8 @@ func copyPMOfromC(mqpmo *C.MQPMO, gopmo *MQPMO) {
 	gopmo.UnknownDestCount = int32(mqpmo.UnknownDestCount)
 	gopmo.InvalidDestCount = int32(mqpmo.InvalidDestCount)
 
-	gopmo.ResolvedQName = C.GoStringN((*C.char)(&mqpmo.ResolvedQName[0]), C.MQ_OBJECT_NAME_LENGTH)
-	gopmo.ResolvedQMgrName = C.GoStringN((*C.char)(&mqpmo.ResolvedQMgrName[0]), C.MQ_OBJECT_NAME_LENGTH)
+	gopmo.ResolvedQName = trimStringN((*C.char)(&mqpmo.ResolvedQName[0]), C.MQ_OBJECT_NAME_LENGTH)
+	gopmo.ResolvedQMgrName = trimStringN((*C.char)(&mqpmo.ResolvedQMgrName[0]), C.MQ_OBJECT_NAME_LENGTH)
 
 	gopmo.RecsPresent = int32(mqpmo.RecsPresent)
 	gopmo.PutMsgRecFields = int32(mqpmo.PutMsgRecFields)

ibmmq/mqiMQSD.go

@@ -181,18 +181,18 @@ func copySDfromC(mqsd *C.MQSD, gosd *MQSD) {
 	gosd.Version = int32(mqsd.Version)
 	gosd.Options = int32(mqsd.Options)
 
-	gosd.ObjectName = C.GoStringN((*C.char)(&mqsd.ObjectName[0]), C.MQ_OBJECT_NAME_LENGTH)
-	gosd.AlternateUserId = C.GoStringN((*C.char)(&mqsd.AlternateUserId[0]), C.MQ_USER_ID_LENGTH)
+	gosd.ObjectName = trimStringN((*C.char)(&mqsd.ObjectName[0]), C.MQ_OBJECT_NAME_LENGTH)
+	gosd.AlternateUserId = trimStringN((*C.char)(&mqsd.AlternateUserId[0]), C.MQ_USER_ID_LENGTH)
 	for i := 0; i < C.MQ_SECURITY_ID_LENGTH; i++ {
 		gosd.AlternateSecurityId[i] = (byte)(mqsd.AlternateSecurityId[i])
 	}
 	gosd.SubExpiry = int32(mqsd.SubExpiry)
 
-	gosd.ObjectString = C.GoStringN((*C.char)(mqsd.ObjectString.VSPtr), (C.int)(mqsd.ObjectString.VSLength))
+	gosd.ObjectString = trimStringN((*C.char)(mqsd.ObjectString.VSPtr), (C.int)(mqsd.ObjectString.VSLength))
 	C.free(unsafe.Pointer(mqsd.ObjectString.VSPtr))
-	gosd.SubName = C.GoStringN((*C.char)(mqsd.SubName.VSPtr), (C.int)(mqsd.SubName.VSLength))
+	gosd.SubName = trimStringN((*C.char)(mqsd.SubName.VSPtr), (C.int)(mqsd.SubName.VSLength))
 	C.free(unsafe.Pointer(mqsd.SubName.VSPtr))
-	gosd.SubUserData = C.GoStringN((*C.char)(mqsd.SubUserData.VSPtr), (C.int)(mqsd.SubUserData.VSLength))
+	gosd.SubUserData = trimStringN((*C.char)(mqsd.SubUserData.VSPtr), (C.int)(mqsd.SubUserData.VSLength))
 	C.free(unsafe.Pointer(mqsd.SubUserData.VSPtr))
 
 	for i = 0; i < C.MQ_CORREL_ID_LENGTH; i++ {
@@ -204,14 +204,14 @@ func copySDfromC(mqsd *C.MQSD, gosd *MQSD) {
 		gosd.PubAccountingToken[i] = (byte)(mqsd.PubAccountingToken[i])
 	}
 
-	gosd.PubApplIdentityData = C.GoStringN((*C.char)(&mqsd.PubApplIdentityData[0]), C.MQ_APPL_IDENTITY_DATA_LENGTH)
+	gosd.PubApplIdentityData = trimStringN((*C.char)(&mqsd.PubApplIdentityData[0]), C.MQ_APPL_IDENTITY_DATA_LENGTH)
 
-	gosd.SelectionString = C.GoStringN((*C.char)(mqsd.SelectionString.VSPtr), (C.int)(mqsd.SelectionString.VSLength))
+	gosd.SelectionString = trimStringN((*C.char)(mqsd.SelectionString.VSPtr), (C.int)(mqsd.SelectionString.VSLength))
 	C.free(unsafe.Pointer(mqsd.SelectionString.VSPtr))
 
 	gosd.SubLevel = int32(mqsd.SubLevel)
 
-	gosd.ResObjectString = C.GoStringN((*C.char)(mqsd.ResObjectString.VSPtr), (C.int)(mqsd.ResObjectString.VSLength))
+	gosd.ResObjectString = trimStringN((*C.char)(mqsd.ResObjectString.VSPtr), (C.int)(mqsd.ResObjectString.VSLength))
 	C.free(unsafe.Pointer(mqsd.ResObjectString.VSPtr))
 	return
 }

ibmmq/mqistr.go

@@ -91,6 +91,9 @@ func MQItoString(class string, value int) string {
 	case "OT":
 		s = C.GoString(C.MQOT_STR(v))
 
+	case "PL":
+		s = C.GoString(C.MQPL_STR(v))
+
 	case "RC":
 		s = C.GoString(C.MQRC_STR(v))
 		if s == "" {