-
Notifications
You must be signed in to change notification settings - Fork 0
/
scholar.go
296 lines (274 loc) · 10.6 KB
/
scholar.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
package go_scholar
import (
"bytes"
"fmt"
"github.com/PuerkitoBio/goquery"
cmap "github.com/orcaman/concurrent-map/v2"
"io"
"log"
"net/http"
"strconv"
"strings"
"time"
)
const BaseURL = "http://scholar.google.com"
const AGENT = "Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Firefox/81.0"
const MAX_TIME_PROFILE = time.Second * 3600 * 24 // 1 Day
const MAX_TIME_ARTICLE = time.Second * 3600 * 24 * 7 // 1 week
type Article struct {
Title string
Authors string
ScholarURL string
Year int
Month int
Day int
NumCitations int
Articles int // if there are more than one article within this publication (it will also tell how big the arrays below are)
Description string
PdfURL string
Journal string
Volume string
Pages string
Publisher string
ScholarCitedByURLs []string
ScholarVersionsURLs []string
ScholarRelatedURLs []string
LastRetrieved time.Time
}
type Profile struct {
User string
LastRetrieved time.Time
Articles []string // list of article URLs - we'd still need to look them up in the article map
}
type Scholar struct {
articles cmap.ConcurrentMap[string, Article] // map of articles by URL
profile cmap.ConcurrentMap[string, Profile] // map of profile by User string
}
func New() Scholar {
return Scholar{
articles: cmap.New[Article](),
profile: cmap.New[Profile](),
}
}
func (a Article) String() string {
return "Article(\n Title=" + a.Title + "\n authors=" + a.Authors + "\n ScholarURL=" + a.ScholarURL + "\n Year=" + strconv.Itoa(a.Year) + "\n Month=" + strconv.Itoa(a.Month) + "\n Day=" + strconv.Itoa(a.Day) + "\n NumCitations=" + strconv.Itoa(a.NumCitations) + "\n Articles=" + strconv.Itoa(a.Articles) + "\n Description=" + a.Description + "\n PdfURL=" + a.PdfURL + "\n Journal=" + a.Journal + "\n Volume=" + a.Volume + "\n Pages=" + a.Pages + "\n Publisher=" + a.Publisher + "\n scholarCitedByURL=" + strings.Join(a.ScholarCitedByURLs, ", ") + "\n scholarVersionsURL=" + strings.Join(a.ScholarVersionsURLs, ", ") + "\n scholarRelatedURL=" + strings.Join(a.ScholarRelatedURLs, ", ") + "\n LastRetrieved=" + a.LastRetrieved.String() + "\n)"
}
func (sch Scholar) QueryProfile(user string, limit int) []Article {
return sch.QueryProfileDumpResponse(user, true, limit, false)
}
func (sch Scholar) QueryProfileWithCache(user string, limit int) []Article {
if sch.profile.Has(user) {
p, _ := sch.profile.Get(user)
lastAccess := p.LastRetrieved
if (time.Now().Sub(lastAccess)).Seconds() > MAX_TIME_PROFILE.Seconds() {
println("Profile cache expired for User: " + user)
sch.profile.Remove(user)
articles := sch.QueryProfileDumpResponse(user, true, limit, false)
var articleList []string
for _, article := range articles {
articleList = append(articleList, article.ScholarURL)
}
sch.profile.Set(user, Profile{User: user, LastRetrieved: time.Now(), Articles: articleList})
} else {
println("Profile cache hit for User: " + user)
// cache hit, return the Articles
articles := make([]Article, 0)
for _, articleURL := range p.Articles {
if sch.articles.Has(articleURL) {
cacheArticle, _ := sch.articles.Get(articleURL)
if (time.Now().Sub(cacheArticle.LastRetrieved)).Seconds() > MAX_TIME_ARTICLE.Seconds() {
println("Cache expired for article: " + articleURL + "\nLast Retrieved: " + cacheArticle.LastRetrieved.String() + "\nDifference: " + time.Now().Sub(cacheArticle.LastRetrieved).String())
article := sch.QueryArticle(articleURL, Article{}, false)
sch.articles.Set(articleURL, article)
articles = append(articles, article)
} else {
println("Cache hit for article: " + articleURL)
articles = append(articles, cacheArticle)
}
} else {
// cache miss, query the article
println("Cache miss for article: " + articleURL)
article := sch.QueryArticle(articleURL, Article{}, false)
articles = append(articles, article)
sch.articles.Set(articleURL, article)
}
}
return articles
}
} else {
println("Profile cache miss for User: " + user)
articles := sch.QueryProfileDumpResponse(user, true, limit, false)
var articleList []string
for _, article := range articles {
articleList = append(articleList, article.ScholarURL)
}
sch.profile.Set(user, Profile{User: user, LastRetrieved: time.Now(), Articles: articleList})
return articles
}
println("Shouldn't have got here")
return []Article{}
}
// QueryProfileDumpResponse queries the profile of a User and returns a list of Articles
// if queryArticles is true, it will also query the Articles for extra information which isn't present on the profile page
//
// we may wish to set this to false if we are only interested in some article info, or we have a cache hit and we just
// want to get updated information from the profile page only to save requests
//
// if dumpResponse is true, it will print the response to stdout (useful for debugging)
func (sch Scholar) QueryProfileDumpResponse(user string, queryArticles bool, limit int, dumpResponse bool) []Article {
var articles []Article
client := &http.Client{}
// todo: make page size configurable, also support getting more than one page of citations
req, err := http.NewRequest("GET", BaseURL+"/citations?user="+user+"&cstart=0&pagesize="+strconv.Itoa(limit), nil)
if err != nil {
log.Fatalln(err)
}
req.Header.Set("User-Agent", AGENT)
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
if resp.StatusCode != 200 {
log.Fatalf("status code error: %d %s", resp.StatusCode, resp.Status)
}
if dumpResponse {
bodyBytes, err := io.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
req.Body = io.NopCloser(bytes.NewBuffer(bodyBytes))
println("GOT AUTHOR PAGE: \n", string(bodyBytes))
}
doc, err := goquery.NewDocumentFromReader(resp.Body)
if err != nil {
log.Fatal(err)
}
doc.Find(".gsc_a_tr").Each(func(i int, s *goquery.Selection) {
var article Article
entry := s.Find(".gsc_a_t")
link := entry.Find(".gsc_a_at")
article.Title = link.Text()
tempURL, _ := link.Attr("href")
article.Year, _ = strconv.Atoi(s.Find(".gsc_a_y").Find("span").Text())
article.NumCitations, _ = strconv.Atoi(s.Find(".gsc_a_c").Children().First().Text())
if queryArticles {
if sch.articles.Has(BaseURL + tempURL) {
// hit the cache
cacheArticle, _ := sch.articles.Get(BaseURL + tempURL)
if (time.Now().Sub(article.LastRetrieved)).Seconds() > MAX_TIME_ARTICLE.Seconds() {
println("Cache expired for article" + BaseURL + tempURL + "\nLast Retrieved: " + cacheArticle.LastRetrieved.String() + "\nDifference: " + time.Now().Sub(cacheArticle.LastRetrieved).String())
// expired cache entry, replace it
sch.articles.Remove(BaseURL + tempURL)
article = sch.QueryArticle(BaseURL+tempURL, article, dumpResponse)
sch.articles.Set(BaseURL+tempURL, article)
} else {
println("Cache hit for article" + BaseURL + tempURL)
// not expired, update any new information
cacheArticle.NumCitations = article.NumCitations // update the citations since thats all that might change
article = cacheArticle
sch.articles.Set(BaseURL+tempURL, article)
}
} else {
println("Cache miss for article" + BaseURL + tempURL)
article = sch.QueryArticle(BaseURL+tempURL, article, dumpResponse)
sch.articles.Set(BaseURL+tempURL, article)
}
}
articles = append(articles, article)
})
return articles
}
func (sch Scholar) QueryArticle(url string, article Article, dumpResponse bool) Article {
fmt.Println("PULLING ARTICLE: " + url)
article.ScholarURL = url
client := &http.Client{}
req, err := http.NewRequest("GET", url, nil)
if err != nil {
log.Fatalln(err)
}
req.Header.Set("User-Agent", AGENT)
resp, err := client.Do(req)
if err != nil {
log.Fatal(err)
}
defer resp.Body.Close()
if resp.StatusCode != 200 {
log.Fatalf("status code error: %d %s", resp.StatusCode, resp.Status)
}
if dumpResponse {
bodyBytes, err := io.ReadAll(resp.Body)
if err != nil {
log.Fatal(err)
}
req.Body = io.NopCloser(bytes.NewBuffer(bodyBytes))
println("GOT ARTICLE: \n", string(bodyBytes))
}
doc, err := goquery.NewDocumentFromReader(resp.Body)
if err != nil {
log.Fatal(err)
}
article.LastRetrieved = time.Now()
article.Articles = 0
article.PdfURL, _ = doc.Find(".gsc_oci_title_ggi").Children().First().Attr("href") // assume the link is the first child
doc.Find(".gs_scl").Each(func(i int, s *goquery.Selection) {
text := s.Find(".gsc_oci_field").Text()
if text == "Authors" {
article.Authors = s.Find(".gsc_oci_value").Text()
}
if text == "Publication date" {
datestring := s.Find(".gsc_oci_value").Text()
parts := strings.Split(datestring, "/")
if len(parts) == 3 {
article.Year, _ = strconv.Atoi(parts[0])
article.Month, _ = strconv.Atoi(parts[1])
article.Day, _ = strconv.Atoi(parts[2])
}
}
if text == "Journal" {
article.Journal = s.Find(".gsc_oci_value").Text()
}
if text == "Volume" {
article.Volume = s.Find(".gsc_oci_value").Text()
}
if text == "Pages" {
article.Pages = s.Find(".gsc_oci_value").Text()
}
if text == "Publisher" {
article.Publisher = s.Find(".gsc_oci_value").Text()
}
if text == "Description" {
article.Description = s.Find(".gsc_oci_value").Text()
}
// don't need to parse here, already have it
//if text == "Total citations" {
// citationString := s.Find(".gsc_oci_value").Text()
// parts := strings.Split(citationString, "Cited by ")
// if len(parts) == 2 {
// article.NumCitations, _ = strconv.Atoi(parts[1])
// }
//}
if text == "Scholar Articles" {
article.Articles += 1
articles := s.Find(".gsc_oci_value")
articles.Find(".gsc_oci_merged_snippet").Each(func(i int, s *goquery.Selection) {
// each one of these is an article. For an scholar-example with multiple see: https://scholar.google.com/citations?view_op=view_citation&hl=en&user=ECQMeb0AAAAJ&citation_for_view=ECQMeb0AAAAJ:u5HHmVD_uO8C
// this seems to happen if the entry is a book and there are Articles within it
s.Find(".gsc_oms_link").Each(func(i int, l *goquery.Selection) {
linkText := l.Text()
linkUrl, _ := l.Attr("href")
if strings.Contains(linkText, "Cited by") {
article.ScholarCitedByURLs = append(article.ScholarCitedByURLs, linkUrl)
}
if strings.Contains(linkText, "Related Articles") {
article.ScholarRelatedURLs = append(article.ScholarRelatedURLs, linkUrl)
}
if strings.Contains(linkText, "versions") {
article.ScholarVersionsURLs = append(article.ScholarVersionsURLs, linkUrl)
}
})
})
}
})
return article
}