forked from synopsys-arc-oss/ownership-plugin
-
Notifications
You must be signed in to change notification settings - Fork 39
/
FolderOwnershipHelper.java
163 lines (147 loc) · 6.07 KB
/
FolderOwnershipHelper.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
/*
* The MIT License
*
* Copyright (c) 2015 Oleg Nenashev.
*
* 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 org.jenkinsci.plugins.ownership.folders;
import com.cloudbees.hudson.plugins.folder.AbstractFolder;
import com.cloudbees.hudson.plugins.folder.AbstractFolderProperty;
import com.cloudbees.hudson.plugins.folder.Folder;
import com.synopsys.arc.jenkins.plugins.ownership.IOwnershipHelper;
import com.synopsys.arc.jenkins.plugins.ownership.OwnershipDescription;
import com.synopsys.arc.jenkins.plugins.ownership.OwnershipPlugin;
import com.synopsys.arc.jenkins.plugins.ownership.jobs.JobOwnerHelper;
import com.synopsys.arc.jenkins.plugins.ownership.jobs.JobOwnerJobProperty;
import com.synopsys.arc.jenkins.plugins.ownership.util.AbstractOwnershipHelper;
import com.synopsys.arc.jenkins.plugins.ownership.util.UserCollectionFilter;
import com.synopsys.arc.jenkins.plugins.ownership.util.userFilters.AccessRightsFilter;
import com.synopsys.arc.jenkins.plugins.ownership.util.userFilters.IUserFilter;
import hudson.Extension;
import hudson.model.Computer;
import hudson.model.Item;
import hudson.model.ItemGroup;
import hudson.model.Job;
import hudson.model.User;
import java.io.IOException;
import java.util.Collection;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import org.jenkinsci.plugins.ownership.model.OwnershipHelperLocator;
/**
* Integration with Folders plugin.
* @author Oleg Nenashev
* @since TODO
*/
public class FolderOwnershipHelper extends AbstractOwnershipHelper<AbstractFolder<?>> {
static final FolderOwnershipHelper INSTANCE = new FolderOwnershipHelper();
@Nonnull
public static FolderOwnershipHelper getInstance() {
return INSTANCE;
}
/**
* Gets OwnerNodeProperty from job if possible.
* @param folder Folder
* @return OwnerNodeProperty or null
*/
@CheckForNull
public static FolderOwnershipProperty getOwnerProperty(@Nonnull AbstractFolder<?> folder) {
FolderOwnershipProperty prop = folder.getProperties().get(FolderOwnershipProperty.class);
return prop != null ? prop : null;
}
@Override
public String getItemTypeName(AbstractFolder<?> item) {
return "folder";
}
@Override
public String getItemDisplayName(AbstractFolder<?> item) {
return item.getDisplayName();
}
@Override
public String getItemURL(AbstractFolder<?> item) {
return item.getUrl();
}
@Override
public OwnershipDescription getOwnershipDescription(AbstractFolder<?> item) {
if (item == null) { // Handle renames, etc.
return OwnershipDescription.DISABLED_DESCR;
}
// Retrieve Ownership from the Folder property
FolderOwnershipProperty prop = getOwnerProperty(item);
if (prop != null) {
OwnershipDescription d = prop.getOwnership();
if (d.isOwnershipEnabled()) {
return prop.getOwnership();
}
}
// We go to upper items in order to get the ownership description
ItemGroup parent = item.getParent();
IOwnershipHelper<ItemGroup> located = OwnershipHelperLocator.locate(parent);
while (located != null) {
OwnershipDescription fromParent = located.getOwnershipDescription(parent);
if (fromParent.isOwnershipEnabled()) {
return fromParent;
}
if (parent instanceof Item) {
Item parentItem = (Item)parent;
parent = parentItem.getParent();
located = OwnershipHelperLocator.locate(parent);
} else {
located = null;
}
}
return OwnershipDescription.DISABLED_DESCR;
}
@Override
public Collection<User> getPossibleOwners(AbstractFolder<?> item) {
if (OwnershipPlugin.getInstance().isRequiresConfigureRights()) {
IUserFilter filter = new AccessRightsFilter(item, Folder.CONFIGURE);
return UserCollectionFilter.filterUsers(User.getAll(), true, filter);
} else {
return User.getAll();
}
}
/**
* Sets the ownership information.
* @param folder Folder to be modified
* @param descr A description to be set. Use null to drop settings.
* @throws IOException
*/
public static void setOwnership(@Nonnull AbstractFolder<?> folder,
@CheckForNull OwnershipDescription descr) throws IOException {
FolderOwnershipProperty prop = getOwnerProperty(folder);
if (prop == null) {
prop = new FolderOwnershipProperty(descr);
folder.addProperty(prop);
} else {
prop.setOwnershipDescription(descr);
}
}
@Extension(optional = true)
public static class LocatorImpl extends OwnershipHelperLocator<AbstractFolder<?>> {
@Override
public IOwnershipHelper<AbstractFolder<?>> findHelper(Object item) {
if (item instanceof AbstractFolder<?>) {
return INSTANCE;
}
return null;
}
}
}