/
pluginApi.go
271 lines (238 loc) · 7.22 KB
/
pluginApi.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
package plugin
import (
"crypto/tls"
"encoding/json"
"fmt"
"io/ioutil"
"log"
"net/http"
"path"
"strings"
"github.com/jenkins-zh/jenkins-client/pkg/core"
"github.com/jenkins-zh/jenkins-client/pkg/util"
httpdownloader "github.com/linuxsuren/http-downloader/pkg"
"go.uber.org/zap"
)
// API represents a plugin API
type API struct {
dependencyMap map[string]string
SkipDependency bool
SkipOptional bool
UseMirror bool
ShowProgress bool
MirrorURL string
DownloadDir string
RoundTripper http.RoundTripper
}
// Dependency represents a plugin dependency
type Dependency struct {
Name string `json:"name"`
Implied bool `json:"implied"`
Optional bool `json:"optional"`
Title string `json:"title"`
Version string `json:"version"`
ShortName string `json:"shortName"`
}
// Info hold the info of a plugin
type Info struct {
BuildDate string `json:"buildDate"`
Dependencies []Dependency `json:"dependencies"`
Excerpt string `json:"excerpt"`
FirstRelease string `json:"firstRelease"`
Gav string `json:"gav"`
Name string `json:"name"`
PreviousTimestamp string `json:"previousTimestamp"`
PreviousVersion string `json:"previousVersion"`
ReleaseTimestamp string `json:"releaseTimestamp"`
RequireCore string `json:"RequireCore"`
Title string `json:"title"`
URL string `json:"url"`
Version string `json:"version"`
SecurityWarnings []SecurityWarning `json:"securityWarnings"`
Stats InfoStats
}
// InfoStats is the plugin info stats
type InfoStats struct {
CurrentInstalls int
Installations []InstallationInfo
InstallationsPerVersion []InstallationInfo
InstallationsPercentage []InstallationInfo
InstallationsPercentagePerVersion []InstallationInfo
Trend int
}
// InstallationInfo represents the plugin installation info
type InstallationInfo struct {
Timestamp int64
Total int
Version string
Percentage float64
}
// SecurityWarning represents the plugin security-warining info
type SecurityWarning struct {
Active bool
ID string
Message string
URL string
Versions []Version
}
// Version represents the SecurityWarning cover version
type Version struct {
// nolint
firstVersion string
// nolint
lastVersion string
}
// Plugins represents multi PluginInfo
type Plugins struct {
Limit int `json:"limit"`
Page int `json:"page"`
Pages int `json:"pages"`
Total int `json:"total"`
Plugins []Info `json:"plugins"`
}
// ShowTrend show the trend of plugins
func (d *API) ShowTrend(name string) (trend string, err error) {
var plugin *Info
if plugin, err = d.GetPlugin(name); err != nil {
return
}
data := []float64{}
installations := plugin.Stats.Installations
offset, count := 0, 10
if len(installations) > count {
offset = len(installations) - count
}
for _, installation := range installations[offset:] {
data = append(data, float64(installation.Total))
}
trend = util.PrintCollectTrend(data)
return
}
// DownloadPlugins will download those plugins from update center
func (d *API) DownloadPlugins(names []string) (err error) {
d.dependencyMap = make(map[string]string)
core.Logger.Info("start to collect plugin dependencies...")
plugins := make([]Info, 0)
for _, name := range names {
core.Logger.Debug("start to collect dependency", zap.String("plugin", name))
if !strings.Contains(name, "@") {
plugins = append(plugins, d.collectDependencies(strings.ToLower(name))...)
} else {
jclient := &Manager{
JenkinsCore: core.JenkinsCore{
RoundTripper: d.RoundTripper,
},
ShowProgress: d.ShowProgress,
UseMirror: d.UseMirror,
MirrorURL: d.MirrorURL,
}
if err = jclient.DownloadPluginWithVersion(name); err != nil {
return
}
}
}
core.Logger.Info("ready to download plugins", zap.Int("total", len(plugins)))
for i, plugin := range plugins {
core.Logger.Info("start to download plugin",
zap.String("name", plugin.Name),
zap.String("version", plugin.Version),
zap.String("url", plugin.URL),
zap.Int("number", i))
if err = d.download(plugin.URL, plugin.Name); err != nil {
core.Logger.Error("download plugin error", zap.String("name", plugin.Name), zap.Error(err))
break
}
}
return
}
func (d *API) getMirrorURL(url string) (mirror string) {
mirror = url
if d.UseMirror && d.MirrorURL != "" {
core.Logger.Debug("replace with mirror", zap.String("original", url))
mirror = strings.ReplaceAll(url, "https://updates.jenkins-ci.org/download/", d.MirrorURL)
}
return
}
func (d *API) download(url string, name string) (err error) {
url = d.getMirrorURL(url)
core.Logger.Info("prepare to download", zap.String("name", name), zap.String("url", url))
downloader := httpdownloader.HTTPDownloader{
RoundTripper: d.RoundTripper,
TargetFilePath: path.Join(d.DownloadDir, fmt.Sprintf("%s.hpi", name)),
URL: url,
ShowProgress: d.ShowProgress,
}
err = downloader.DownloadFile()
return
}
// GetPlugin will get the plugin information
func (d *API) GetPlugin(name string) (plugin *Info, err error) {
var cli = http.Client{}
if d.RoundTripper == nil {
cli.Transport = &http.Transport{
TLSClientConfig: &tls.Config{
InsecureSkipVerify: true,
},
}
} else {
cli.Transport = d.RoundTripper
}
pluginAPI := fmt.Sprintf("https://plugins.jenkins.io/api/plugin/%s", name)
core.Logger.Debug("fetch data from plugin API", zap.String("url", pluginAPI))
var resp *http.Response
if resp, err = cli.Get(pluginAPI); err == nil {
var body []byte
if body, err = ioutil.ReadAll(resp.Body); err == nil {
plugin = &Info{}
err = json.Unmarshal(body, plugin)
}
}
return
}
func (d *API) collectDependencies(pluginName string) (plugins []Info) {
plugin, err := d.GetPlugin(pluginName)
if err != nil {
log.Println("can't get the plugin by name:", pluginName)
panic(err)
}
plugins = make([]Info, 0)
plugins = append(plugins, *plugin)
if d.SkipDependency {
return
}
for _, dependency := range plugin.Dependencies {
if d.SkipOptional && dependency.Optional {
continue
}
if _, ok := d.dependencyMap[dependency.Name]; !ok {
d.dependencyMap[dependency.Name] = dependency.Version
plugins = append(plugins, d.collectDependencies(dependency.Name)...)
}
}
return
}
// BatchSearchPlugins will batch search plugins
func (d *API) BatchSearchPlugins(pluginNames string) (plugins []Info, err error) {
var cli = http.Client{}
if d.RoundTripper == nil {
cli.Transport = &http.Transport{
TLSClientConfig: &tls.Config{
InsecureSkipVerify: true,
},
}
} else {
cli.Transport = d.RoundTripper
}
pluginAPI := fmt.Sprintf("https://plugins.jenkins.io/api/plugins/?q=%s&page=1&limit=1000", pluginNames)
core.Logger.Debug("fetch data from plugin API", zap.String("url", pluginAPI))
var resp *http.Response
if resp, err = cli.Get(pluginAPI); err == nil {
var body []byte
if body, err = ioutil.ReadAll(resp.Body); err == nil {
var pluginsInfo Plugins
err = json.Unmarshal(body, &pluginsInfo)
plugins = pluginsInfo.Plugins
}
}
return
}