summaryrefslogtreecommitdiff
path: root/tools/network/cloudflare/listRecords.go
blob: 34efc71d5398bb42f8766ad7c72b85fdcc5f9a1f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
// Copyright (C) 2019-2023 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand.  If not, see <https://www.gnu.org/licenses/>.

package cloudflare

import (
	"encoding/json"
	"fmt"
	"io"
	"net/http"
	"net/url"
)

// listDNSRecordRequest creates a new http request for listing of DNS records.
func listDNSRecordRequest(zoneID string, authToken string, recordType string, name string, content string, page uint, perPage uint, order string, direction string, match string) (*http.Request, error) {
	// verify and validate input parameters.
	if page == 0 {
		page = 1
	}
	if perPage < 5 {
		perPage = 5
	}
	if perPage > 100 {
		perPage = 100
	}
	if direction != "asc" && direction != "desc" {
		direction = ""
	}
	if match != "any" && match != "all" {
		match = "all"
	}

	// build all the arguments
	uriValues := make(url.Values)
	if len(recordType) > 0 {
		uriValues.Add("type", recordType)
	}
	if len(name) > 0 {
		uriValues.Add("name", name)
	}
	if len(content) > 0 {
		uriValues.Add("content", content)
	}
	uriValues.Add("page", fmt.Sprintf("%d", page))
	uriValues.Add("per_page", fmt.Sprintf("%d", perPage))
	if len(order) > 0 {
		uriValues.Add("order", order)
	}
	if len(direction) > 0 {
		uriValues.Add("direction", direction)
	}
	uriValues.Add("match", match)

	// construct the query
	uri, err := url.Parse(fmt.Sprintf("%szones/%s/dns_records?%s", cloudFlareURI, zoneID, uriValues.Encode()))
	if err != nil {
		return nil, err
	}
	request, err := http.NewRequest("GET", uri.String(), nil)
	if err != nil {
		return nil, err
	}
	addHeaders(request, authToken)
	return request, nil
}

// ListDNSRecordError is the JSON data structure for a single error during list dns records request
type ListDNSRecordError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
}

// ListDNSRecordResponse is the JSON data structure returned when we list the dns records
type ListDNSRecordResponse struct {
	Result     []DNSRecordResponseEntry    `json:"result"`
	ResultInfo DNSRecordResponseResultInfo `json:"result_info"`
	Errors     []ListDNSRecordError        `json:"errors"`
	Messages   []interface{}               `json:"messages"`
}

// DNSRecordResponseResultInfo is paging status for the returned JSON structure ListDNSRecordResponse
type DNSRecordResponseResultInfo struct {
	Page       int `json:"page"`
	PerPage    int `json:"per_page"`
	TotalPages int `json:"total_pages"`
	Count      int `json:"count"`
	TotalCount int `json:"total_count"`
}

// DNSRecordResponseEntry represent a single returned DNS record entry
type DNSRecordResponseEntry struct {
	ID         string `json:"id"`
	Type       string `json:"type"`
	Name       string `json:"name"`
	Content    string `json:"content"`
	Proxiable  bool   `json:"proxiable"`
	Proxied    bool   `json:"proxied"`
	TTL        int    `json:"ttl"`
	Priority   int    `json:"priority"`
	Locked     bool   `json:"locked"`
	ZoneID     string `json:"zone_id"`
	ZoneName   string `json:"zone_name"`
	ModifiedOn string `json:"modified_on"`
	CreatedOn  string `json:"created_on"`
}

// parseListDNSRecordResponse parses the response that was received as a result of a ListDNSRecordRequest
func parseListDNSRecordResponse(response *http.Response) (*ListDNSRecordResponse, error) {
	defer response.Body.Close()
	body, err := io.ReadAll(response.Body)
	if err != nil {
		return nil, err
	}
	var parsedResponse ListDNSRecordResponse
	if err := json.Unmarshal(body, &parsedResponse); err != nil {
		return nil, fmt.Errorf("failed to unmarshal response body '%s' : %v", string(body), err)
	}
	return &parsedResponse, nil
}