mirror of https://github.com/matrix-org/gomatrix
Added default filter values & filter validation (#46)
Signed-off-by: Thibaut CHARLES cromfr@gmail.com
This commit is contained in:
parent
072b39f7fa
commit
76dfc7718a
53
filter.go
53
filter.go
|
@ -14,6 +14,8 @@
|
||||||
|
|
||||||
package gomatrix
|
package gomatrix
|
||||||
|
|
||||||
|
import "errors"
|
||||||
|
|
||||||
//Filter is used by clients to specify how the server should filter responses to e.g. sync requests
|
//Filter is used by clients to specify how the server should filter responses to e.g. sync requests
|
||||||
//Specified by: https://matrix.org/docs/spec/client_server/r0.2.0.html#filtering
|
//Specified by: https://matrix.org/docs/spec/client_server/r0.2.0.html#filtering
|
||||||
type Filter struct {
|
type Filter struct {
|
||||||
|
@ -21,7 +23,11 @@ type Filter struct {
|
||||||
EventFields []string `json:"event_fields,omitempty"`
|
EventFields []string `json:"event_fields,omitempty"`
|
||||||
EventFormat string `json:"event_format,omitempty"`
|
EventFormat string `json:"event_format,omitempty"`
|
||||||
Presence FilterPart `json:"presence,omitempty"`
|
Presence FilterPart `json:"presence,omitempty"`
|
||||||
Room struct {
|
Room RoomFilter `json:"room,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// RoomFilter is used to define filtering rules for room events
|
||||||
|
type RoomFilter struct {
|
||||||
AccountData FilterPart `json:"account_data,omitempty"`
|
AccountData FilterPart `json:"account_data,omitempty"`
|
||||||
Ephemeral FilterPart `json:"ephemeral,omitempty"`
|
Ephemeral FilterPart `json:"ephemeral,omitempty"`
|
||||||
IncludeLeave bool `json:"include_leave,omitempty"`
|
IncludeLeave bool `json:"include_leave,omitempty"`
|
||||||
|
@ -29,15 +35,56 @@ type Filter struct {
|
||||||
Rooms []string `json:"rooms,omitempty"`
|
Rooms []string `json:"rooms,omitempty"`
|
||||||
State FilterPart `json:"state,omitempty"`
|
State FilterPart `json:"state,omitempty"`
|
||||||
Timeline FilterPart `json:"timeline,omitempty"`
|
Timeline FilterPart `json:"timeline,omitempty"`
|
||||||
} `json:"room,omitempty"`
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// FilterPart is used to define filtering rules for specific categories of events
|
||||||
type FilterPart struct {
|
type FilterPart struct {
|
||||||
NotRooms []string `json:"not_rooms,omitempty"`
|
NotRooms []string `json:"not_rooms,omitempty"`
|
||||||
Rooms []string `json:"rooms,omitempty"`
|
Rooms []string `json:"rooms,omitempty"`
|
||||||
Limit *int `json:"limit,omitempty"`
|
Limit int `json:"limit,omitempty"`
|
||||||
NotSenders []string `json:"not_senders,omitempty"`
|
NotSenders []string `json:"not_senders,omitempty"`
|
||||||
NotTypes []string `json:"not_types,omitempty"`
|
NotTypes []string `json:"not_types,omitempty"`
|
||||||
Senders []string `json:"senders,omitempty"`
|
Senders []string `json:"senders,omitempty"`
|
||||||
Types []string `json:"types,omitempty"`
|
Types []string `json:"types,omitempty"`
|
||||||
|
ContainsURL *bool `json:"contains_url,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Validate checks if the filter contains valid property values
|
||||||
|
func (filter *Filter) Validate() error {
|
||||||
|
if filter.EventFormat != "client" && filter.EventFormat != "federation" {
|
||||||
|
return errors.New("Bad event_format value. Must be one of [\"client\", \"federation\"]")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// DefaultFilter returns the default filter used by the Matrix server if no filter is provided in the request
|
||||||
|
func DefaultFilter() Filter {
|
||||||
|
return Filter{
|
||||||
|
AccountData: DefaultFilterPart(),
|
||||||
|
EventFields: nil,
|
||||||
|
EventFormat: "client",
|
||||||
|
Presence: DefaultFilterPart(),
|
||||||
|
Room: RoomFilter{
|
||||||
|
AccountData: DefaultFilterPart(),
|
||||||
|
Ephemeral: DefaultFilterPart(),
|
||||||
|
IncludeLeave: false,
|
||||||
|
NotRooms: nil,
|
||||||
|
Rooms: nil,
|
||||||
|
State: DefaultFilterPart(),
|
||||||
|
Timeline: DefaultFilterPart(),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// DefaultFilterPart returns the default filter part used by the Matrix server if no filter is provided in the request
|
||||||
|
func DefaultFilterPart() FilterPart {
|
||||||
|
return FilterPart{
|
||||||
|
NotRooms: nil,
|
||||||
|
Rooms: nil,
|
||||||
|
Limit: 20,
|
||||||
|
NotSenders: nil,
|
||||||
|
NotTypes: nil,
|
||||||
|
Senders: nil,
|
||||||
|
Types: nil,
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue