Merge pull request #53 from DisgoOrg/feature/audit-log-fetching

Feature/audit log fetching

Author: Skye-31

api/audit_log.go

@@ -1,5 +1,11 @@
 package api
 
+import (
+	"encoding/json"
+
+	"github.com/DisgoOrg/restclient"
+)
+
 // AuditLogChangeKey (https://discord.com/developers/docs/resources/audit-log#audit-log-change-object-audit-log-change-key) is data representing changes values/settings in an audit log.
 type AuditLogChangeKey struct {
 	Name                        *string                     `json:"name"`
@@ -62,7 +68,7 @@ type AuditLogChangeKey struct {
 // AuditLogEvent is an 8-bit unsigned integer representing an audit log event.
 type AuditLogEvent int
 
-// AuditLogEventGuildUpdate
+// AuditLogEventGuildUpdate ...
 const (
 	AuditLogEventGuildUpdate AuditLogEvent = 1
 )
@@ -159,10 +165,59 @@ type AuditLogEntry struct {
 	Reason     *string                    `json:"reason"`
 }
 
+// AuditLogFilterOptions fields used to filter audit-log retrieving
+type AuditLogFilterOptions struct {
+	UserID     Snowflake
+	ActionType AuditLogEvent
+	Before     Snowflake
+	Limit      int
+}
+
 // AuditLog (https://discord.com/developers/docs/resources/audit-log) These are logs of events that occurred, accessible via the Discord API.
 type AuditLog struct {
-	Webhooks     []Webhook
-	Users        []User
-	Entries      []AuditLogEntry
-	Integrations []Integration
+	Disgo                 Disgo                      `json:"-"`
+	GuildID               Snowflake                  `json:"-"`
+	AuditLogFilterOptions AuditLogFilterOptions      `json:"-"`
+	Webhooks              map[Snowflake]*Webhook     `json:"webhooks"`
+	Users                 map[Snowflake]*User        `json:"users"`
+	Integrations          map[Snowflake]*Integration `json:"integrations"`
+	Entries               []AuditLogEntry            `json:"entries"`
+}
+
+// Unmarshal unmarshals a AuditLog
+func (l *AuditLog) Unmarshal(data []byte) (err error) {
+	var i *struct {
+		Webhooks     []*Webhook      `json:"webhooks"`
+		Users        []*User         `json:"users"`
+		Integrations []*Integration  `json:"integrations"`
+		Entries      []AuditLogEntry `json:"entries"`
+	}
+
+	if err = json.Unmarshal(data, &i); err != nil {
+		return
+	}
+
+	for _, webhook := range i.Webhooks {
+		l.Webhooks[webhook.ID] = webhook
+	}
+
+	for _, user := range i.Users {
+		l.Users[user.ID] = user
+	}
+
+	for _, integration := range i.Integrations {
+		l.Integrations[integration.ID] = integration
+	}
+
+	l.Entries = i.Entries
+	return
+}
+
+// Before gets new AuditLog(s) from Discord before the last one
+func (l *AuditLog) Before() (*AuditLog, restclient.RestError) {
+	before := Snowflake("")
+	if len(l.Entries) > 0 {
+		before = l.Entries[len(l.Entries)-1].ID
+	}
+	return l.Disgo.RestClient().GetAuditLog(l.GuildID, l.AuditLogFilterOptions.UserID, l.AuditLogFilterOptions.ActionType, before, l.AuditLogFilterOptions.Limit)
 }

api/channels.go

@@ -124,3 +124,10 @@ type TextChannel struct {
 type StoreChannel struct {
 	GuildChannel
 }
+
+// PartialChannel contains basic info about a Channel
+type PartialChannel struct {
+	ID   Snowflake   `json:"id"`
+	Type ChannelType `json:"type"`
+	Name *string     `json:"name,omitempty"`
+}

api/entity_builder.go

@@ -35,6 +35,7 @@ type EntityBuilder interface {
 	CreateRole(guildID Snowflake, role *Role, updateCache CacheStrategy) *Role
 	CreateVoiceState(guildID Snowflake, voiceState *VoiceState, updateCache CacheStrategy) *VoiceState
 
+	CreateAuditLog(guildID Snowflake, auditLogFilterOptions AuditLogFilterOptions, auditLog *AuditLog, updateCache CacheStrategy) *AuditLog
 	CreateIntegration(guildID Snowflake, integration *Integration, updateCache CacheStrategy) *Integration
 
 	CreateTextChannel(channel *Channel, updateCache CacheStrategy) *TextChannel

api/guild.go

@@ -259,6 +259,11 @@ func (g *Guild) IconURL(size int) *string {
 	return &u
 }
 
+// GetAuditLogs gets AuditLog(s) for this Guild
+func (g *Guild) GetAuditLogs(userID Snowflake, actionType AuditLogEvent, before Snowflake, limit int) (*AuditLog, restclient.RestError) {
+	return g.Disgo.RestClient().GetAuditLog(g.ID, userID, actionType, before, limit)
+}
+
 // GetIntegrations gets all Integration(s) from the Guild. Requires PermissionManageServer
 func (g *Guild) GetIntegrations() ([]*Integration, restclient.RestError) {
 	return g.Disgo.RestClient().GetIntegrations(g.ID)

api/restclient.go

@@ -56,6 +56,7 @@ type RestClient interface {
 	AddMemberRole(guildID Snowflake, userID Snowflake, roleID Snowflake) restclient.RestError
 	RemoveMemberRole(guildID Snowflake, userID Snowflake, roleID Snowflake) restclient.RestError
 
+	GetAuditLog(guildID Snowflake, userID Snowflake, actionType AuditLogEvent, before Snowflake, limit int) (*AuditLog, restclient.RestError)
 	GetIntegrations(guildID Snowflake) ([]*Integration, restclient.RestError)
 	DeleteIntegration(guildID Snowflake, integrationID Snowflake) restclient.RestError
 

api/webhook.go

@@ -12,17 +12,17 @@ const (
 
 // Webhook (https://discord.com/developers/docs/resources/webhook) is a way to post messages to Discord using the Discord API which do not require bot authentication or use.
 type Webhook struct {
-	ID            Snowflake    `json:"id"`
-	Type          WebhookType  `json:"type"`
-	Username      Snowflake    `json:"username"`
-	GuildID       *Snowflake   `json:"guild_id"`
-	ChannelID     Snowflake    `json:"channel_id"`
-	User          *User        `json:"user"`
-	Name          string       `json:"name"`
-	Avatar        string       `json:"avatar"`
-	Token         *string      `json:"token"`
-	ApplicationID *Snowflake   `json:"application_id"`
-	SourceGuild   *Guild       `json:"source_guild"`
-	SourceChannel *TextChannel `json:"source_channel"`
-	URL           *string      `json:"url"`
+	ID            Snowflake       `json:"id"`
+	Type          WebhookType     `json:"type"`
+	Username      Snowflake       `json:"username"`
+	GuildID       *Snowflake      `json:"guild_id"`
+	ChannelID     Snowflake       `json:"channel_id"`
+	User          *User           `json:"user"`
+	Name          string          `json:"name"`
+	Avatar        string          `json:"avatar"`
+	Token         *string         `json:"token"`
+	ApplicationID *Snowflake      `json:"application_id"`
+	SourceGuild   *PartialGuild   `json:"source_guild"`
+	SourceChannel *PartialChannel `json:"source_channel"`
+	URL           *string         `json:"url"`
 }

example/go.sum

@@ -1,7 +1,7 @@
 github.com/DisgoOrg/log v1.0.3 h1:IjmZQQu/kuBIui22EdXmxzQGYwcPCJEkXa0Fe6W9fJk=
 github.com/DisgoOrg/log v1.0.3/go.mod h1:KFGKhBQr37d6rxZ7p2bmc8BEmDH8DZbtgdlJDSCsE7I=
-github.com/DisgoOrg/restclient v1.2.3 h1:lSvsS63oYlnUH72dgIVfc+hWS24rPzHyaf22ZPF0E7Q=
-github.com/DisgoOrg/restclient v1.2.3/go.mod h1:PIhyYsT52w5T6m4LT+HTdKqY6NOIqo71Ai0rgaq9ZtM=
+github.com/DisgoOrg/restclient v1.2.4 h1:gSU4+XL9vvIOybD9kVcS47Et1IFdiBNgex+0VS1NWfY=
+github.com/DisgoOrg/restclient v1.2.4/go.mod h1:PIhyYsT52w5T6m4LT+HTdKqY6NOIqo71Ai0rgaq9ZtM=
 github.com/PaesslerAG/gval v1.1.1 h1:4d7pprU9876+m3rc08X33UjGip8oV1kkm8Gh5GBuTss=
 github.com/PaesslerAG/gval v1.1.1/go.mod h1:Fa8gfkCmUsELXgayr8sfL/sw+VzCVoa03dcOcR/if2w=
 github.com/PaesslerAG/jsonpath v0.1.0 h1:gADYeifvlqK3R3i2cR5B4DGgxLXIPb3TRTH1mGi0jPI=

internal/entity_builder_impl.go

@@ -282,6 +282,18 @@ func (b *EntityBuilderImpl) CreateRole(guildID api.Snowflake, role *api.Role, up
 	return role
 }
 
+// CreateAuditLog returns a new api.AuditLog entity
+func (b *EntityBuilderImpl) CreateAuditLog(guildID api.Snowflake, auditLogFilterOptions api.AuditLogFilterOptions, auditLog *api.AuditLog, updateCache api.CacheStrategy) *api.AuditLog {
+	auditLog.Disgo = b.Disgo()
+	auditLog.GuildID = guildID
+	auditLog.AuditLogFilterOptions = auditLogFilterOptions
+
+	for _, user := range auditLog.Users {
+		user = b.CreateUser(user, updateCache)
+	}
+	return auditLog
+}
+
 // CreateIntegration returns a new api.Integration entity
 func (b *EntityBuilderImpl) CreateIntegration(guildID api.Snowflake, integration *api.Integration, updateCache api.CacheStrategy) *api.Integration {
 	integration.Disgo = b.Disgo()

internal/restclient_impl.go

@@ -435,6 +435,39 @@ func (r *restClientImpl) MoveMember(guildID api.Snowflake, userID api.Snowflake,
 	return
 }
 
+func (r *restClientImpl) GetAuditLog(guildID api.Snowflake, userID api.Snowflake, actionType api.AuditLogEvent, before api.Snowflake, limit int) (auditLog *api.AuditLog, rErr restclient.RestError) {
+	values := restclient.QueryValues{}
+	if guildID != "" {
+		values["guild_id"] = guildID
+	}
+	if userID != "" {
+		values["user_id"] = userID
+	}
+	if actionType != 0 {
+		values["action_type"] = actionType
+	}
+	if before != "" {
+		values["before"] = guildID
+	}
+	if limit != 0 {
+		values["limit"] = limit
+	}
+	compiledRoute, err := restclient.GetAuditLogs.Compile(values, guildID)
+	if err != nil {
+		return nil, restclient.NewError(nil, err)
+	}
+	rErr = r.Do(compiledRoute, nil, &auditLog)
+	if rErr == nil {
+		auditLog = r.Disgo().EntityBuilder().CreateAuditLog(guildID, api.AuditLogFilterOptions{
+			UserID:     userID,
+			ActionType: actionType,
+			Before:     before,
+			Limit:      limit,
+		}, auditLog, api.CacheStrategyNoWs)
+	}
+	return
+}
+
 func (r *restClientImpl) GetIntegrations(guildID api.Snowflake) (integrations []*api.Integration, rErr restclient.RestError) {
 	compiledRoute, err := restclient.GetIntegrations.Compile(nil, guildID)
 	if err != nil {