go-ethereum/vendor/github.com/cloudflare/cloudflare-go/auditlogs.go

package cloudflare

import (
	"encoding/base64"
	"encoding/json"
	"fmt"
	"time"
)

// AuditLogAction is a member of AuditLog, the action that was taken.
type AuditLogAction struct {
	Result bool   `json:"result"`
	Type   string `json:"type"`
}

// AuditLogActor is a member of AuditLog, who performed the action.
type AuditLogActor struct {
	Email string `json:"email"`
	ID    string `json:"id"`
	IP    string `json:"ip"`
	Type  string `json:"type"`
}

// AuditLogOwner is a member of AuditLog, who owns this audit log.
type AuditLogOwner struct {
	ID string `json:"id"`
}

// AuditLogResource is a member of AuditLog, what was the action performed on.
type AuditLogResource struct {
	ID   string `json:"id"`
	Type string `json:"type"`
}

// AuditLog is an resource that represents an update in the cloudflare dash
type AuditLog struct {
	Action   AuditLogAction         `json:"action"`
	Actor    AuditLogActor          `json:"actor"`
	ID       string                 `json:"id"`
	Metadata map[string]interface{} `json:"metadata"`
	NewValue string                 `json:"newValue"`
	OldValue string                 `json:"oldValue"`
	Owner    AuditLogOwner          `json:"owner"`
	Resource AuditLogResource       `json:"resource"`
	When     time.Time              `json:"when"`
}

// AuditLogResponse is the response returned from the cloudflare v4 api
type AuditLogResponse struct {
	Response   Response
	Result     []AuditLog `json:"result"`
	ResultInfo `json:"result_info"`
}

// AuditLogFilter is an object for filtering the audit log response from the api.
type AuditLogFilter struct {
	ID         string
	ActorIP    string
	ActorEmail string
	Direction  string
	ZoneName   string
	Since      string
	Before     string
	PerPage    int
	Page       int
}

// String turns an audit log filter in to an HTTP Query Param
// list. It will not inclue empty members of the struct in the
// query parameters.
func (a AuditLogFilter) String() string {
	params := "?"
	if a.ID != "" {
		params += "&id=" + a.ID
	}
	if a.ActorIP != "" {
		params += "&actor.ip=" + a.ActorIP
	}
	if a.ActorEmail != "" {
		params += "&actor.email=" + a.ActorEmail
	}
	if a.ZoneName != "" {
		params += "&zone.name=" + a.ZoneName
	}
	if a.Direction != "" {
		params += "&direction=" + a.Direction
	}
	if a.Since != "" {
		params += "&since=" + a.Since
	}
	if a.Before != "" {
		params += "&before=" + a.Before
	}
	if a.PerPage > 0 {
		params += "&per_page=" + fmt.Sprintf("%d", a.PerPage)
	}
	if a.Page > 0 {
		params += "&page=" + fmt.Sprintf("%d", a.Page)
	}
	return params
}

// GetOrganizationAuditLogs will return the audit logs of a specific
// organization, based on the ID passed in. The audit logs can be
// filtered based on any argument in the AuditLogFilter
//
// API Reference: https://api.cloudflare.com/#audit-logs-list-organization-audit-logs
func (api *API) GetOrganizationAuditLogs(organizationID string, a AuditLogFilter) (AuditLogResponse, error) {
	uri := "/organizations/" + organizationID + "/audit_logs" + fmt.Sprintf("%s", a)

	res, err := api.makeRequest("GET", uri, nil)
	if err != nil {
		return AuditLogResponse{}, err
	}
	buf, err := base64.RawStdEncoding.DecodeString(string(res))
	if err != nil {
		return AuditLogResponse{}, err
	}
	return unmarshalReturn(buf)
}

// unmarshalReturn will unmarshal bytes and return an auditlogresponse
func unmarshalReturn(res []byte) (AuditLogResponse, error) {
	var auditResponse AuditLogResponse
	err := json.Unmarshal(res, &auditResponse)
	if err != nil {
		return auditResponse, err
	}
	return auditResponse, nil
}

// GetUserAuditLogs will return your user's audit logs. The audit logs can be
// filtered based on any argument in the AuditLogFilter
//
// API Reference: https://api.cloudflare.com/#audit-logs-list-user-audit-logs
func (api *API) GetUserAuditLogs(a AuditLogFilter) (AuditLogResponse, error) {
	uri := "/user/audit_logs" + fmt.Sprintf("%s", a)
	res, err := api.makeRequest("GET", uri, nil)
	if err != nil {
		return AuditLogResponse{}, err
	}
	return unmarshalReturn(res)
}