-
Notifications
You must be signed in to change notification settings - Fork 10
/
parser.go
388 lines (342 loc) · 9.23 KB
/
parser.go
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
package edgar
import (
"bufio"
"errors"
"fmt"
"io"
"log"
"sort"
"strconv"
"strings"
"sync"
"golang.org/x/net/html"
)
func parseCikAndDocID(url string) (string, string) {
var s1 string
var d1, d2, d3, d4 int
fmt.Sscanf(url, "/cgi-bin/viewer?action=view&cik=%d&accession_number=%d-%d-%d%s", &d1, &d2, &d3, &d4, &s1)
cik := fmt.Sprintf("%d", d1)
an := fmt.Sprintf("%010d%d%d", d2, d3, d4)
return cik, an
}
/*
This is the parsing of query page where we get the list of filings of a given types
ex: https://www.sec.gov/cgi-bin/browse-edgar?CIK=AAPL&owner=exclude&action=getcompany&type=10-Q&count=1&dateb=
Assumptions of the parser:
- There is interactive data available and there is a button that allows the user to click it
- Since it is a link the tag will be a hyperlink with a button with the id=interactiveDataBtn
- The actual link is the href attribute in the "a" token just before the id attribute
*/
func queryPageParser(page io.Reader, docType FilingType) map[string]string {
filingInfo := make(map[string]string)
z := html.NewTokenizer(page)
data, err := parseTableRow(z, true)
for err == nil {
//This check for filing type will drop AMEND filings
if len(data) == 5 && data[0] == string(docType) {
//Drop filings before 2010
year := getYear(data[3])
if year >= thresholdYear {
filingInfo[data[3]] = data[1]
}
}
data, err = parseTableRow(z, true)
}
return filingInfo
}
func cikPageParser(page io.Reader) (string, error) {
z := html.NewTokenizer(page)
token := z.Token()
for !(token.Data == "cik" && token.Type == html.StartTagToken) {
tt := z.Next()
if tt == html.ErrorToken {
return "", errors.New("Could not find the CIK")
}
token = z.Token()
}
for !(token.Data == "cik" && token.Type == html.EndTagToken) {
if token.Type == html.TextToken {
str := strings.TrimSpace(token.String())
if len(str) > 0 {
return str, nil
}
}
z.Next()
token = z.Token()
}
return "", errors.New("Could not find the CIK")
}
/*
The filing page parser
- The top of the page has a list of reports.
- Get all the reports (link to all the reports) and put it in an array
- The Accordian on the side of the page identifies what each report is
- Get the text of the accordian and map the type of the report to the report
- Create a map of the report to report link
*/
func filingPageParser(page io.Reader, fileType FilingType) map[filingDocType]string {
var filingLinks []string
r := bufio.NewReader(page)
s, e := r.ReadString('\n')
for e == nil {
//Get the number of reports available
if strings.Contains(s, "var reports") == true {
s1 := strings.Split(s, "(")
s2 := strings.Split(s1[1], ")")
cnt, _ := strconv.Atoi(s2[0])
//cnt-1 because we skip the 'all' in the list
for i := 0; i < cnt-1; i++ {
if s, e = r.ReadString('\n'); e != nil {
panic(e.Error())
}
s1 := strings.Split(s, " = ")
s2 := strings.Split(s1[1], ";")
s3 := strings.Trim(s2[0], "\"")
s4 := strings.Split(s3, ".")
s5 := s3
//Sometimes the report is listed as an xml file??
if s4[1] == "xml" {
s5 = s4[0] + ".htm"
}
if !strings.Contains(s5, "htm") {
panic("Dont know this type of report")
}
filingLinks = append(filingLinks, s5)
}
break
}
s, e = r.ReadString('\n')
}
docs := mapReports(page, filingLinks)
return docs
}
func parseTableData(z *html.Tokenizer, parseHref bool) string {
token := z.Token()
if token.Type != html.StartTagToken && token.Data != "td" {
log.Fatal("Tokenizer passed incorrectly to parseTableData")
return ""
}
for !(token.Data == "td" && token.Type == html.EndTagToken) {
if token.Type == html.ErrorToken {
break
}
if parseHref && token.Data == "a" && token.Type == html.StartTagToken {
str := parseHyperLinkTag(z, token)
if len(str) > 0 {
return str
}
} else {
if token.Type == html.TextToken {
str := strings.TrimSpace(token.String())
if len(str) > 0 {
return str
}
}
}
//Going for the end of the td tag
z.Next()
token = z.Token()
}
return ""
}
func parseTableRow(z *html.Tokenizer, parseHref bool) ([]string, error) {
var retData []string
//Get the current token
token := z.Token()
//Check if this is really a table row
for !(token.Type == html.StartTagToken && token.Data == "tr") {
tt := z.Next()
if tt == html.ErrorToken {
return nil, errors.New("Done with parsing")
}
token = z.Token()
}
//Till the end of the row collect data from each data block
for !(token.Data == "tr" && token.Type == html.EndTagToken) {
if token.Type == html.ErrorToken {
return nil, errors.New("Done with parsing")
}
if token.Data == "td" && token.Type == html.StartTagToken {
parseFlag := parseHref
//If the data is a number class just get the text = number
for _, a := range token.Attr {
if a.Key == "class" && (a.Val == "nump" || a.Val == "num") {
parseFlag = false
}
}
str := parseTableData(z, parseFlag)
if len(str) > 0 {
retData = append(retData, str)
}
}
z.Next()
token = z.Token()
}
return retData, nil
}
var reqHyperLinks = map[string]bool{
"interactiveDataBtn": true,
}
func parseHyperLinkTag(z *html.Tokenizer, token html.Token) string {
var href string
var onclick string
var id string
for _, a := range token.Attr {
switch a.Key {
case "id":
id = a.Val
case "href":
href = a.Val
case "onclick":
onclick = a.Val
if str, err := getFinDataXBRLTag(onclick); err == nil {
return str
}
}
}
text := ""
//Finish up the hyperlink
for !(token.Data == "a" && token.Type == html.EndTagToken) {
/*
if token.Type == html.TextToken {
str := strings.TrimSpace(token.String())
if len(str) > 0 {
text = str
}
}
*/
z.Next()
token = z.Token()
}
if _, ok := reqHyperLinks[id]; ok {
return href
}
return text
}
func parseTableTitle(z *html.Tokenizer) []string {
var strs []string
token := z.Token()
if token.Type != html.StartTagToken && token.Data != "th" {
log.Fatal("Tokenizer passed incorrectly to parseTableData")
return strs
}
for !(token.Data == "th" && token.Type == html.EndTagToken) {
if token.Type == html.ErrorToken {
break
}
if token.Type == html.TextToken {
str := strings.TrimSpace(token.String())
if len(str) > 0 {
strs = append(strs, str)
}
}
//Going for the end of the td tag
z.Next()
token = z.Token()
}
return strs
}
func parseTableHeading(z *html.Tokenizer) ([]string, error) {
var retData []string
//Get the current token
token := z.Token()
//Check if this is really a table row
for !(token.Type == html.StartTagToken && token.Data == "tr") {
tt := z.Next()
if tt == html.ErrorToken {
return nil, errors.New("Done with parsing")
}
token = z.Token()
}
//Till the end of the row collect data from each data block
for !(token.Data == "tr" && token.Type == html.EndTagToken) {
if token.Type == html.ErrorToken {
return nil, errors.New("Done with parsing")
}
if token.Data == "th" && token.Type == html.StartTagToken {
str := parseTableTitle(z)
if len(str) > 0 {
retData = append(retData, str...)
}
}
z.Next()
token = z.Token()
}
return retData, nil
}
func parseFilingScale(z *html.Tokenizer, t filingDocType) map[scaleEntity]scaleFactor {
scales := make(map[scaleEntity]scaleFactor)
data, err := parseTableHeading(z)
if err == nil {
if len(data) > 0 {
scales = filingScale(data, t)
}
}
return scales
}
/*
This function takes any report filed under a company and looks
for XBRL tags that Filing is interested in to gather and store.
XBRL tag is mapped to a finDataType which is then used to lookup
the passed in interface fields to see if there is a match and set
that field
*/
func finReportParser(page io.Reader, fr *financialReport, t filingDocType) (*financialReport, error) {
z := html.NewTokenizer(page)
scales := parseFilingScale(z, t)
data, err := parseTableRow(z, true)
for err == nil {
if len(data) > 0 {
finType := getFinDataTypeFromXBRLTag(data[0])
if finType != finDataUnknown {
for _, str := range data[1:] {
if len(str) > 0 {
if setData(fr, finType, str, scales, t) == nil {
break
}
}
}
}
}
data, err = parseTableRow(z, true)
}
return fr, nil
}
// parseAllReports gets all the reports filed under a given account normalizeNumber
func parseAllReports(cik string, an string) []int {
var reports []int
url := "https://www.sec.gov/Archives/edgar/data/" + cik + "/" + an + "/"
page := getPage(url)
z := html.NewTokenizer(page)
data, err := parseTableRow(z, false)
for err == nil {
var num int
if len(data) > 0 && strings.Contains(data[0], "R") {
_, err = fmt.Sscanf(data[0], "R%d.htm", &num)
if err == nil {
reports = append(reports, num)
}
}
data, err = parseTableRow(z, false)
}
sort.Slice(reports, func(i, j int) bool {
return reports[i] < reports[j]
})
return reports
}
func parseMappedReports(docs map[filingDocType]string, docType FilingType) (*financialReport, error) {
var wg sync.WaitGroup
fr := newFinancialReport(docType)
for t, url := range docs {
wg.Add(1)
go func(url string, fr *financialReport, t filingDocType) {
defer wg.Done()
page := getPage(url)
if page != nil {
finReportParser(page, fr, t)
}
}(baseURL+url, fr, t)
}
wg.Wait()
return fr, validateFinancialReport(fr)
}