From 20e02cc9ad460e6519cf6d89c4722f00dfd4f49f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?CORNIERE=20R=C3=A9mi?= Date: Tue, 14 Jan 2020 22:47:49 +0100 Subject: [PATCH 1/3] Added node config --- .../xmpp_pubsub_client/xmpp_ps_client.go | 42 +++++++++++++++++++ stanza/form.go | 4 +- stanza/form_test.go | 2 +- stanza/pubsub_owner.go | 31 +++++++++++--- stanza/pubsub_owner_test.go | 4 +- stanza/pubsub_test.go | 4 +- 6 files changed, 74 insertions(+), 13 deletions(-) diff --git a/_examples/xmpp_pubsub_client/xmpp_ps_client.go b/_examples/xmpp_pubsub_client/xmpp_ps_client.go index 972b94d..eba9bbd 100644 --- a/_examples/xmpp_pubsub_client/xmpp_ps_client.go +++ b/_examples/xmpp_pubsub_client/xmpp_ps_client.go @@ -178,5 +178,47 @@ func main() { purgeRq, _ := stanza.NewPurgeAllItems(serviceName, nodeName) client.SendIQ(ctx, purgeRq) + // ============================= + // Configure the node : + confRq, _ := stanza.NewConfigureNode(serviceName, nodeName) + confReqCh, err := client.SendIQ(ctx, confRq) + select { + case confForm := <-confReqCh: + fields, err := confForm.GetFormFields() + if err != nil { + log.Fatal("No config fields found !") + } + + // These are some common fields expected to be present. Change processing to your liking + if fields["pubsub#max_payload_size"] != nil { + fields["pubsub#max_payload_size"].ValuesList[0] = "100000" + } + + if fields["pubsub#notification_type"] != nil { + fields["pubsub#notification_type"].ValuesList[0] = "headline" + } + + submitConf, err := stanza.NewFormSubmissionOwner(serviceName, + nodeName, + []*stanza.Field{ + fields["pubsub#max_payload_size"], + fields["pubsub#notification_type"], + }) + + c, _ := client.SendIQ(ctx, submitConf) + select { + case <-c: + fmt.Println("node configuration was successful") + case <-time.After(300 * time.Millisecond): + cancel() + log.Fatal("No iq response was received in time") + + } + + case <-time.After(300 * time.Millisecond): + cancel() + log.Fatal("No iq response was received in time") + } + cancel() } diff --git a/stanza/form.go b/stanza/form.go index b9a9932..f22c6ce 100644 --- a/stanza/form.go +++ b/stanza/form.go @@ -17,7 +17,7 @@ type Form struct { XMLName xml.Name `xml:"jabber:x:data x"` Instructions []string `xml:"instructions"` Title string `xml:"title,omitempty"` - Fields []Field `xml:"field,omitempty"` + Fields []*Field `xml:"field,omitempty"` Reported *FormItem `xml:"reported"` Items []FormItem Type string `xml:"type,attr"` @@ -38,7 +38,7 @@ type Field struct { Label string `xml:"label,attr,omitempty"` } -func NewForm(fields []Field, formType string) *Form { +func NewForm(fields []*Field, formType string) *Form { return &Form{ Type: formType, Fields: fields, diff --git a/stanza/form_test.go b/stanza/form_test.go index a68d88e..7346db2 100644 --- a/stanza/form_test.go +++ b/stanza/form_test.go @@ -57,7 +57,7 @@ func TestMarshalFormSubmit(t *testing.T) { Node: serviceNode, Form: &Form{ Type: FormTypeSubmit, - Fields: []Field{ + Fields: []*Field{ {Var: "FORM_TYPE", Type: FieldTypeHidden, ValuesList: []string{"http://jabber.org/protocol/pubsub#node_config"}}, {Var: "pubsub#title", ValuesList: []string{"Princely Musings (Atom)"}}, {Var: "pubsub#deliver_notifications", ValuesList: []string{"1"}}, diff --git a/stanza/pubsub_owner.go b/stanza/pubsub_owner.go index 054303f..9adfbef 100644 --- a/stanza/pubsub_owner.go +++ b/stanza/pubsub_owner.go @@ -198,7 +198,7 @@ func NewApprovePendingSubRequest(serviceId, sessionId, nodeId string) (IQ, error form := &Form{ Type: FormTypeSubmit, - Fields: []Field{{Var: "pubsub#node", ValuesList: []string{nodeId}}}, + Fields: []*Field{{Var: "pubsub#node", ValuesList: []string{nodeId}}}, } data, err := xml.Marshal(form) if err != nil { @@ -262,25 +262,44 @@ func NewAffiliationListRequest(serviceId, nodeID string) (IQ, error) { return iq, nil } +// NewFormSubmission builds a form submission pubsub IQ, in the Owner namespace +// This is typically used to respond to a form issued by the server when configuring a node. +// See 8.2.4 Form Submission +func NewFormSubmissionOwner(serviceId, nodeName string, fields []*Field) (IQ, error) { + if serviceId == "" || nodeName == "" { + return IQ{}, errors.New("serviceId and nodeName must be filled for this request to be valid") + } + + submitConf := NewIQ(Attrs{Type: IQTypeSet, To: serviceId}) + submitConf.Payload = &PubSubOwner{ + OwnerUseCase: &ConfigureOwner{ + Node: nodeName, + Form: NewForm(fields, + FormTypeSubmit)}, + } + + return submitConf, nil +} + // GetFormFields gets the fields from a form in a IQ stanza of type result, as a map. // Key is the "var" attribute of the field, and field is the value. // The user can then select and modify the fields they want to alter, and submit a new form to the service using the // NewFormSubmission function to build the IQ. // TODO : remove restriction on IQ type ? -func (iq *IQ) GetFormFields() (map[string]Field, error) { +func (iq *IQ) GetFormFields() (map[string]*Field, error) { if iq.Type != IQTypeResult { return nil, errors.New("this IQ is not a result type IQ. Cannot extract the form from it") } switch payload := iq.Payload.(type) { // We support IOT Control IQ case *PubSubGeneric: - fieldMap := make(map[string]Field) + fieldMap := make(map[string]*Field) for _, elt := range payload.Configure.Form.Fields { fieldMap[elt.Var] = elt } return fieldMap, nil case *PubSubOwner: - fieldMap := make(map[string]Field) + fieldMap := make(map[string]*Field) co, ok := payload.OwnerUseCase.(*ConfigureOwner) if !ok { return nil, errors.New("this IQ does not contain a PubSub payload with a configure tag for the owner namespace") @@ -291,7 +310,7 @@ func (iq *IQ) GetFormFields() (map[string]Field, error) { return fieldMap, nil default: if iq.Any != nil { - fieldMap := make(map[string]Field) + fieldMap := make(map[string]*Field) if iq.Any.XMLName.Local != "command" { return nil, errors.New("this IQ does not contain a form") } @@ -307,7 +326,7 @@ func (iq *IQ) GetFormFields() (map[string]Field, error) { } err = xml.Unmarshal(data, &f) if err == nil { - fieldMap[f.Var] = f + fieldMap[f.Var] = &f } } } diff --git a/stanza/pubsub_owner_test.go b/stanza/pubsub_owner_test.go index 8af6194..665fba3 100644 --- a/stanza/pubsub_owner_test.go +++ b/stanza/pubsub_owner_test.go @@ -357,7 +357,7 @@ func TestNewApproveSubRequest(t *testing.T) { apprForm := &stanza.Form{ Type: stanza.FormTypeSubmit, - Fields: []stanza.Field{ + Fields: []*stanza.Field{ {Var: "FORM_TYPE", Type: stanza.FieldTypeHidden, ValuesList: []string{"http://jabber.org/protocol/pubsub#subscribe_authorization"}}, {Var: "pubsub#subid", ValuesList: []string{"123-abc"}}, {Var: "pubsub#node", ValuesList: []string{"princely_musings"}}, @@ -381,7 +381,7 @@ func TestNewApproveSubRequest(t *testing.T) { for _, f := range frm.Fields { if f.Var == "pubsub#allow" { - allowField = &f + allowField = f } } if allowField == nil || allowField.ValuesList[0] != "true" { diff --git a/stanza/pubsub_test.go b/stanza/pubsub_test.go index 95bf640..6b413c4 100644 --- a/stanza/pubsub_test.go +++ b/stanza/pubsub_test.go @@ -8,7 +8,7 @@ import ( "testing" ) -var submitFormExample = stanza.NewForm([]stanza.Field{ +var submitFormExample = stanza.NewForm([]*stanza.Field{ {Var: "FORM_TYPE", Type: stanza.FieldTypeHidden, ValuesList: []string{"http://jabber.org/protocol/pubsub#node_config"}}, {Var: "pubsub#title", ValuesList: []string{"Princely Musings (Atom)"}}, {Var: "pubsub#deliver_notifications", ValuesList: []string{"1"}}, @@ -741,7 +741,7 @@ func TestNewCreateAndConfigNode(t *testing.T) { "princely_musings", &stanza.Form{ Type: stanza.FormTypeSubmit, - Fields: []stanza.Field{ + Fields: []*stanza.Field{ {Var: "FORM_TYPE", Type: stanza.FieldTypeHidden, ValuesList: []string{"http://jabber.org/protocol/pubsub#node_config"}}, {Var: "pubsub#notify_retract", ValuesList: []string{"0"}}, {Var: "pubsub#notify_sub", ValuesList: []string{"0"}}, From 1d1adb0c48afed92c0a8585d389968f5fc0966d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?CORNIERE=20R=C3=A9mi?= Date: Tue, 14 Jan 2020 23:13:13 +0100 Subject: [PATCH 2/3] Example pubsub code cleanup --- .../xmpp_pubsub_client/xmpp_ps_client.go | 166 +++++++++++------- 1 file changed, 102 insertions(+), 64 deletions(-) diff --git a/_examples/xmpp_pubsub_client/xmpp_ps_client.go b/_examples/xmpp_pubsub_client/xmpp_ps_client.go index eba9bbd..14f0fb0 100644 --- a/_examples/xmpp_pubsub_client/xmpp_ps_client.go +++ b/_examples/xmpp_pubsub_client/xmpp_ps_client.go @@ -32,10 +32,10 @@ func main() { router.NewRoute().Packet("message"). HandlerFunc(func(s xmpp.Sender, p stanza.Packet) { data, _ := xml.Marshal(p) - fmt.Println("Received a publication ! => \n" + string(data)) + log.Println("Received a message ! => \n" + string(data)) }) - client, err := xmpp.NewClient(config, router, func(err error) { fmt.Println(err) }) + client, err := xmpp.NewClient(config, router, func(err error) { log.Println(err) }) if err != nil { log.Fatalf("%+v", err) } @@ -49,11 +49,45 @@ func main() { // ========================== // Create a node + ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second) + createNode(ctx, cancel, client) + + // ============================= + // Configure the node. This can also be done in a single message with the creation + configureNode(ctx, cancel, client) + + // ==================================== + // Subscribe to this node : + subToNode(ctx, cancel, client) + + // ========================== + // Publish to that node + pubToNode(ctx, cancel, client) + + // ============================= + // Let's purge the node : + purgeRq, _ := stanza.NewPurgeAllItems(serviceName, nodeName) + purgeCh, err := client.SendIQ(ctx, purgeRq) + select { + case purgeResp := <-purgeCh: + if purgeResp.Error != nil { + cancel() + log.Fatalf("error while purging node : %s", purgeResp.Error.Text) + } + log.Println("node successfully purged") + case <-time.After(1000 * time.Millisecond): + cancel() + log.Fatal("No iq response was received in time while purging node") + } + + cancel() +} + +func createNode(ctx context.Context, cancel context.CancelFunc, client *xmpp.Client) { rqCreate, err := stanza.NewCreateNode(serviceName, nodeName) if err != nil { log.Fatalf("%+v", err) } - ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second) createCh, err := client.SendIQ(ctx, rqCreate) if err != nil { log.Fatalf("%+v", err) @@ -67,20 +101,73 @@ func main() { if respCr.Error.Reason != "conflict" { log.Fatalf("%+v", respCr.Error.Text) } - fmt.Println(respCr.Error.Text) + log.Println(respCr.Error.Text) } else { fmt.Print("successfully created channel") } case <-time.After(100 * time.Millisecond): cancel() - log.Fatal("No iq response was received in time") + log.Fatal("No iq response was received in time while creating node") } } } +} - // ==================================== - // Now let's subscribe to this node : - rqSubscribe, _ := stanza.NewSubRq(serviceName, stanza.SubInfo{ +func configureNode(ctx context.Context, cancel context.CancelFunc, client *xmpp.Client) { + // First, ask for a form with the config options + confRq, _ := stanza.NewConfigureNode(serviceName, nodeName) + confReqCh, err := client.SendIQ(ctx, confRq) + if err != nil { + log.Fatalf("could not send iq : %v", err) + } + select { + case confForm := <-confReqCh: + // If the request was successful, we now have a form with configuration options to update + fields, err := confForm.GetFormFields() + if err != nil { + log.Fatal("No config fields found !") + } + + // These are some common fields expected to be present. Change processing to your liking + if fields["pubsub#max_payload_size"] != nil { + fields["pubsub#max_payload_size"].ValuesList[0] = "100000" + } + + if fields["pubsub#notification_type"] != nil { + fields["pubsub#notification_type"].ValuesList[0] = "headline" + } + + // Send the modified fields as a form + submitConf, err := stanza.NewFormSubmissionOwner(serviceName, + nodeName, + []*stanza.Field{ + fields["pubsub#max_payload_size"], + fields["pubsub#notification_type"], + }) + + c, _ := client.SendIQ(ctx, submitConf) + select { + case confResp := <-c: + if confResp.Error != nil { + cancel() + log.Fatalf("node configuration failed : %s", confResp.Error.Text) + } + log.Println("node configuration was successful") + return + + case <-time.After(300 * time.Millisecond): + cancel() + log.Fatal("No iq response was received in time while configuring the node") + } + + case <-time.After(300 * time.Millisecond): + cancel() + log.Fatal("No iq response was received in time while asking for the config form") + } +} + +func subToNode(ctx context.Context, cancel context.CancelFunc, client *xmpp.Client) { + rqSubscribe, err := stanza.NewSubRq(serviceName, stanza.SubInfo{ Node: nodeName, Jid: userJID, }) @@ -91,15 +178,15 @@ func main() { if subRespCh != nil { select { case <-subRespCh: - fmt.Println("Subscribed to the service") - case <-time.After(100 * time.Millisecond): + log.Println("Subscribed to the service") + case <-time.After(300 * time.Millisecond): cancel() - log.Fatal("No iq response was received in time") + log.Fatal("No iq response was received in time while subscribing") } } +} - // ========================== - // Publish to that node +func pubToNode(ctx context.Context, cancel context.CancelFunc, client *xmpp.Client) { pub, err := stanza.NewPublishItemRq(serviceName, nodeName, "", stanza.Item{ Publisher: "testuser2", Any: &stanza.Node{ @@ -166,59 +253,10 @@ func main() { if pubRespCh != nil { select { case <-pubRespCh: - fmt.Println("Published item to the service") - case <-time.After(100 * time.Millisecond): - cancel() - log.Fatal("No iq response was received in time") - } - } - - // ============================= - // Let's purge the node now : - purgeRq, _ := stanza.NewPurgeAllItems(serviceName, nodeName) - client.SendIQ(ctx, purgeRq) - - // ============================= - // Configure the node : - confRq, _ := stanza.NewConfigureNode(serviceName, nodeName) - confReqCh, err := client.SendIQ(ctx, confRq) - select { - case confForm := <-confReqCh: - fields, err := confForm.GetFormFields() - if err != nil { - log.Fatal("No config fields found !") - } - - // These are some common fields expected to be present. Change processing to your liking - if fields["pubsub#max_payload_size"] != nil { - fields["pubsub#max_payload_size"].ValuesList[0] = "100000" - } - - if fields["pubsub#notification_type"] != nil { - fields["pubsub#notification_type"].ValuesList[0] = "headline" - } - - submitConf, err := stanza.NewFormSubmissionOwner(serviceName, - nodeName, - []*stanza.Field{ - fields["pubsub#max_payload_size"], - fields["pubsub#notification_type"], - }) - - c, _ := client.SendIQ(ctx, submitConf) - select { - case <-c: - fmt.Println("node configuration was successful") + log.Println("Published item to the service") case <-time.After(300 * time.Millisecond): cancel() - log.Fatal("No iq response was received in time") - + log.Fatal("No iq response was received in time while publishing") } - - case <-time.After(300 * time.Millisecond): - cancel() - log.Fatal("No iq response was received in time") } - - cancel() } From e9bda893d6d7b98e07c6c60559647f950aefc3bd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?CORNIERE=20R=C3=A9mi?= Date: Tue, 14 Jan 2020 23:47:18 +0100 Subject: [PATCH 3/3] Added tests for new Owner namespace function --- stanza/pubsub_owner_test.go | 52 +++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/stanza/pubsub_owner_test.go b/stanza/pubsub_owner_test.go index 665fba3..b7cf6db 100644 --- a/stanza/pubsub_owner_test.go +++ b/stanza/pubsub_owner_test.go @@ -816,6 +816,58 @@ func TestGetFormFieldsCmd(t *testing.T) { } +func TestNewFormSubmissionOwner(t *testing.T) { + expectedReq := "" + + " " + + " " + + "http://jabber.org/protocol/pubsub#node_config " + + "604800 roster " + + " friends servants " + + "courtiers " + + subR, err := stanza.NewFormSubmissionOwner("pubsub.shakespeare.lit", + "princely_musings", + []*stanza.Field{ + {Var: "FORM_TYPE", Type: stanza.FieldTypeHidden, ValuesList: []string{"http://jabber.org/protocol/pubsub#node_config"}}, + {Var: "pubsub#item_expire", ValuesList: []string{"604800"}}, + {Var: "pubsub#access_model", ValuesList: []string{"roster"}}, + {Var: "pubsub#roster_groups_allowed", ValuesList: []string{"friends", "servants", "courtiers"}}, + }) + subR.Id = "config2" + if err != nil { + t.Fatalf("Could not create request : %s", err) + } + + if _, e := checkMarshalling(t, subR); e != nil { + t.Fatalf("Failed to check marshalling for generated sub request : %s", e) + } + + pubsub, ok := subR.Payload.(*stanza.PubSubOwner) + if !ok { + t.Fatalf("payload is not a pubsub in namespace owner !") + } + + conf, ok := pubsub.OwnerUseCase.(*stanza.ConfigureOwner) + if !ok { + t.Fatalf("pubsub does not contain a configure node !") + } + + if conf.Form == nil { + t.Fatalf("the form is absent from the configuration submission !") + } + if len(conf.Form.Fields) != 4 { + t.Fatalf("expected 4 fields, found %d", len(conf.Form.Fields)) + } + if len(conf.Form.Fields[3].ValuesList) != 3 { + t.Fatalf("expected 3 values in fourth field, found %d", len(conf.Form.Fields[3].ValuesList)) + } + + data, err := xml.Marshal(subR) + if err := compareMarshal(expectedReq, string(data)); err != nil { + t.Fatalf(err.Error()) + } +} + func getPubSubOwnerPayload(response string) (*stanza.PubSubOwner, error) { var respIQ stanza.IQ err := xml.Unmarshal([]byte(response), &respIQ)