-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
/
MyViewsProperty.java
266 lines (214 loc) · 7.71 KB
/
MyViewsProperty.java
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
/*
* The MIT License
*
* Copyright (c) 2004-2010, Sun Microsystems, Inc., Tom Huybrechts
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package hudson.model;
import hudson.Extension;
import hudson.Util;
import hudson.model.Descriptor.FormException;
import hudson.security.ACL;
import hudson.security.Permission;
import hudson.util.FormValidation;
import hudson.views.MyViewsTabBar;
import hudson.views.ViewsTabBar;
import java.io.IOException;
import java.text.ParseException;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;
import javax.servlet.ServletException;
import jenkins.model.Jenkins;
import net.sf.json.JSONObject;
import org.acegisecurity.AccessDeniedException;
import org.kohsuke.stapler.DataBoundConstructor;
import org.kohsuke.stapler.HttpRedirect;
import org.kohsuke.stapler.HttpResponse;
import org.kohsuke.stapler.QueryParameter;
import org.kohsuke.stapler.StaplerFallback;
import org.kohsuke.stapler.StaplerRequest;
import org.kohsuke.stapler.StaplerResponse;
/**
* A UserProperty that remembers user-private views.
*
* @author Tom Huybrechts
*/
public class MyViewsProperty extends UserProperty implements ViewGroup, Action, StaplerFallback {
private String primaryViewName;
/**
* Always hold at least one view.
*/
private CopyOnWriteArrayList<View> views = new CopyOnWriteArrayList<View>();
private transient ViewGroupMixIn viewGroupMixIn;
@DataBoundConstructor
public MyViewsProperty(String primaryViewName) {
this.primaryViewName = primaryViewName;
}
private MyViewsProperty() {
readResolve();
}
public Object readResolve() {
if (views == null)
// this shouldn't happen, but an error in 1.319 meant the last view could be deleted
views = new CopyOnWriteArrayList<View>();
if (views.isEmpty())
// preserve the non-empty invariant
views.add(new AllView(Messages.Hudson_ViewName(), this));
viewGroupMixIn = new ViewGroupMixIn(this) {
protected List<View> views() { return views; }
protected String primaryView() { return primaryViewName; }
protected void primaryView(String name) { primaryViewName=name; }
};
return this;
}
public String getPrimaryViewName() {
return primaryViewName;
}
public void setPrimaryViewName(String primaryViewName) {
this.primaryViewName = primaryViewName;
}
public User getUser() {
return user;
}
///// ViewGroup methods /////
public String getUrl() {
return user.getUrl() + "/my-views/";
}
public void save() throws IOException {
user.save();
}
public Collection<View> getViews() {
return viewGroupMixIn.getViews();
}
public View getView(String name) {
return viewGroupMixIn.getView(name);
}
public boolean canDelete(View view) {
return viewGroupMixIn.canDelete(view);
}
public void deleteView(View view) throws IOException {
viewGroupMixIn.deleteView(view);
}
public void onViewRenamed(View view, String oldName, String newName) {
viewGroupMixIn.onViewRenamed(view,oldName,newName);
}
public void addView(View view) throws IOException {
viewGroupMixIn.addView(view);
}
public View getPrimaryView() {
return viewGroupMixIn.getPrimaryView();
}
public HttpResponse doIndex() {
return new HttpRedirect("view/" + Util.encode(getPrimaryView().getViewName()) + "/");
}
public synchronized void doCreateView(StaplerRequest req, StaplerResponse rsp)
throws IOException, ServletException, ParseException, FormException {
checkPermission(View.CREATE);
addView(View.create(req, rsp, this));
}
/**
* Checks if a private view with the given name exists.
* An error is returned if exists==true but the view does not exist.
* An error is also returned if exists==false but the view does exist.
**/
public FormValidation doViewExistsCheck(@QueryParameter String value, @QueryParameter boolean exists) {
checkPermission(View.CREATE);
String view = Util.fixEmpty(value);
if (view == null) return FormValidation.ok();
if (exists) {
return (getView(view)!=null) ?
FormValidation.ok() :
FormValidation.error(Messages.MyViewsProperty_ViewExistsCheck_NotExist(view));
} else {
return (getView(view)==null) ?
FormValidation.ok() :
FormValidation.error(Messages.MyViewsProperty_ViewExistsCheck_AlreadyExists(view));
}
}
public ACL getACL() {
return user.getACL();
}
public void checkPermission(Permission permission) throws AccessDeniedException {
getACL().checkPermission(permission);
}
public boolean hasPermission(Permission permission) {
return getACL().hasPermission(permission);
}
///// Action methods /////
public String getDisplayName() {
return Messages.MyViewsProperty_DisplayName();
}
public String getIconFileName() {
return "user.png";
}
public String getUrlName() {
return "my-views";
}
@Extension
public static class DescriptorImpl extends UserPropertyDescriptor {
@Override
public String getDisplayName() {
return Messages.MyViewsProperty_DisplayName();
}
@Override
public UserProperty newInstance(User user) {
return new MyViewsProperty();
}
}
@Override
public UserProperty reconfigure(StaplerRequest req, JSONObject form) throws FormException {
req.bindJSON(this, form);
return this;
}
public ViewsTabBar getViewsTabBar() {
return Jenkins.getInstance().getViewsTabBar();
}
public ItemGroup<? extends TopLevelItem> getItemGroup() {
return Jenkins.getInstance();
}
public List<Action> getViewActions() {
// Jenkins.getInstance().getViewActions() are tempting but they are in a wrong scope
return Collections.emptyList();
}
public Object getStaplerFallback() {
return getPrimaryView();
}
public MyViewsTabBar getMyViewsTabBar() {
return Jenkins.getInstance().getMyViewsTabBar();
}
@Extension
public static class GlobalAction implements RootAction {
public String getDisplayName() {
return Messages.MyViewsProperty_GlobalAction_DisplayName();
}
public String getIconFileName() {
// do not show when not logged in
if (User.current() == null ) {
return null;
}
return "user.png";
}
public String getUrlName() {
return "/me/my-views";
}
}
}