make Modify method return result and err

Author: jamesgoodhouse

client.go

@@ -17,7 +17,7 @@ type Client interface {
 
 	Add(addRequest *AddRequest) error
 	Del(delRequest *DelRequest) error
-	Modify(modifyRequest *ModifyRequest) error
+	Modify(modifyRequest *ModifyRequest) (*ModifyResult, error)
 	ModifyDN(modifyDNRequest *ModifyDNRequest) error
 
 	Compare(dn, attribute, value string) (bool, error)

example_test.go

@@ -154,7 +154,7 @@ func ExampleConn_Modify() {
 	modify.Add("description", []string{"An example user"})
 	modify.Replace("mail", []string{"[email protected]"})
 
-	err = l.Modify(modify)
+	_, err = l.Modify(modify)
 	if err != nil {
 		log.Fatal(err)
 	}

modify.go

@@ -27,7 +27,7 @@ package ldap
 
 import (
 	"errors"
-	"log"
+	"fmt"
 
 	"gopkg.in/asn1-ber.v1"
 )
@@ -47,6 +47,12 @@ type PartialAttribute struct {
 	Vals []string
 }
 
+// ModifyResult holds the server's response to a modify request
+type ModifyResult struct {
+	// Controls are the returned controls
+	Controls []Control
+}
+
 func (p *PartialAttribute) encode() *ber.Packet {
 	seq := ber.Encode(ber.ClassUniversal, ber.TypeConstructed, ber.TagSequence, nil, "PartialAttribute")
 	seq.AppendChild(ber.NewString(ber.ClassUniversal, ber.TypePrimitive, ber.TagOctetString, p.Type, "Type"))
@@ -125,7 +131,7 @@ func NewModifyRequest(
 }
 
 // Modify performs the ModifyRequest
-func (l *Conn) Modify(modifyRequest *ModifyRequest) error {
+func (l *Conn) Modify(modifyRequest *ModifyRequest) (*ModifyResult, error) {
 	packet := ber.Encode(ber.ClassUniversal, ber.TypeConstructed, ber.TagSequence, nil, "LDAP Request")
 	packet.AppendChild(ber.NewInteger(ber.ClassUniversal, ber.TypePrimitive, ber.TagInteger, l.nextMessageID(), "MessageID"))
 	packet.AppendChild(modifyRequest.encode())
@@ -137,37 +143,48 @@ func (l *Conn) Modify(modifyRequest *ModifyRequest) error {
 
 	msgCtx, err := l.sendMessage(packet)
 	if err != nil {
-		return err
+		return nil, err
 	}
 	defer l.finishMessage(msgCtx)
 
+	result := &ModifyResult{
+		Controls: make([]Control, 0),
+	}
+
 	l.Debug.Printf("%d: waiting for response", msgCtx.id)
 	packetResponse, ok := <-msgCtx.responses
 	if !ok {
-		return NewError(ErrorNetwork, errors.New("ldap: response channel closed"))
+		return nil, NewError(ErrorNetwork, errors.New("ldap: response channel closed"))
 	}
 	packet, err = packetResponse.ReadPacket()
 	l.Debug.Printf("%d: got response %p", msgCtx.id, packet)
 	if err != nil {
-		return err
+		return nil, err
 	}
 
 	if l.Debug {
 		if err := addLDAPDescriptions(packet); err != nil {
-			return err
+			return nil, err
 		}
 		ber.PrintPacket(packet)
 	}
 
-	if packet.Children[1].Tag == ApplicationModifyResponse {
+	switch packet.Children[1].Tag {
+	case ApplicationModifyResponse:
 		err := GetLDAPError(packet)
 		if err != nil {
-			return err
+			return nil, err
+		}
+		if len(packet.Children) == 3 {
+			for _, child := range packet.Children[2].Children {
+				decodedChild, err := DecodeControl(child)
+				if err != nil {
+					return nil, fmt.Errorf("failed to decode child control: %s", err)
+				}
+				result.Controls = append(result.Controls, decodedChild)
+			}
 		}
-	} else {
-		log.Printf("Unexpected Response: %d", packet.Children[1].Tag)
 	}
-
 	l.Debug.Printf("%d: returning", msgCtx.id)
-	return nil
+	return result, nil
 }