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 package info.magnolia.setup.for4_5;
35
36 import static java.lang.String.format;
37 import static org.apache.commons.lang3.ArrayUtils.contains;
38
39 import info.magnolia.cms.core.Content;
40 import info.magnolia.cms.core.HierarchyManager;
41 import info.magnolia.cms.core.NodeData;
42 import info.magnolia.cms.filters.FilterManager;
43 import info.magnolia.cms.util.ContentUtil;
44 import info.magnolia.jcr.util.NodeTypes;
45 import info.magnolia.module.InstallContext;
46 import info.magnolia.module.delta.AbstractRepositoryTask;
47 import info.magnolia.module.delta.TaskExecutionException;
48
49 import java.util.Collection;
50 import java.util.Set;
51
52 import javax.jcr.RepositoryException;
53
54 import org.apache.commons.lang3.ArrayUtils;
55 import org.apache.commons.lang3.StringUtils;
56 import org.slf4j.Logger;
57 import org.slf4j.LoggerFactory;
58
59 import com.google.common.base.Function;
60 import com.google.common.base.Predicates;
61 import com.google.common.collect.Iterables;
62 import com.google.common.collect.Sets;
63
64
65
66
67 public class UpdateSecurityFilterClientCallbacksConfiguration extends AbstractRepositoryTask {
68
69 private static final Logger log = LoggerFactory.getLogger(UpdateSecurityFilterClientCallbacksConfiguration.class);
70
71 private static final String FORM_CLASS = "info.magnolia.cms.security.auth.callback.FormClientCallback";
72 private static final String COMPOSITE_CLASS = "info.magnolia.cms.security.auth.callback.CompositeCallback";
73 private static final String BASIC_CLASS = "info.magnolia.cms.security.auth.callback.BasicClientCallback";
74 private static final String REDIRECT_CLASS = "info.magnolia.cms.security.auth.callback.RedirectClientCallback";
75 private static final String[] SIMPLE_CALLBACK_CLASSES = new String[]{FORM_CLASS, BASIC_CLASS, REDIRECT_CLASS};
76 private final String fromFilterName;
77 private final String targetFilterName;
78 private boolean wereWeAbleToUpdateEverything = true;
79
80 public UpdateSecurityFilterClientCallbacksConfiguration(String fromFilterName, String targetFilterName) {
81 super("Security filter configuration", "Moves the client callback configuration from the " + fromFilterName + " to the new " + targetFilterName + " filter to enable multiple client callbacks.");
82 this.fromFilterName = fromFilterName;
83 this.targetFilterName = targetFilterName;
84 }
85
86 @Override
87 protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException {
88 final HierarchyManager hm = ctx.getConfigHierarchyManager();
89 final Content fromFilterNode = hm.getContent(FilterManager.SERVER_FILTERS + "/" + fromFilterName);
90 final Content targetFilterNode = hm.getContent(FilterManager.SERVER_FILTERS + "/" + targetFilterName);
91
92 final Content newCallbacksNode = targetFilterNode.createContent("clientCallbacks", NodeTypes.ContentNode.NAME);
93 final Content currentCallbackNode = fromFilterNode.getContent("clientCallback");
94 final String currentClass = currentCallbackNode.getNodeData("class").getString();
95 if (contains(SIMPLE_CALLBACK_CLASSES, currentClass)) {
96 addCallback(ctx, newCallbacksNode, null, currentCallbackNode, null);
97 } else if (!currentCallbackNode.hasChildren()) {
98
99 addCallback(ctx, newCallbacksNode, "custom", currentCallbackNode, null);
100 } else if (COMPOSITE_CLASS.equals(currentClass)) {
101 final Collection<Content> existingCallbacks = currentCallbackNode.getContent("patterns").getChildren();
102 for (Content existingCallback : existingCallbacks) {
103 final String clazz = existingCallback.getNodeData("class").getString();
104 if ("info.magnolia.cms.util.UrlPatternDelegate".equals(clazz)) {
105 final String url = existingCallback.getNodeData("url").getString();
106 addCallback(ctx, newCallbacksNode, existingCallback.getName(), existingCallback.getContent("delegate"), url);
107 } else {
108 ctx.warn("Unknown callback class at " + existingCallback.getHandle() + ":" + clazz);
109 wereWeAbleToUpdateEverything = false;
110 }
111 }
112 } else {
113 ctx.warn("Unknown callback class:" + currentClass);
114 wereWeAbleToUpdateEverything = false;
115 }
116
117
118 if (wereWeAbleToUpdateEverything) {
119 currentCallbackNode.delete();
120 } else {
121 ContentUtil.moveInSession(currentCallbackNode, fromFilterNode.getHandle() + "/_clientCallback_backup_config");
122 ctx.warn(format(
123 "Client callback configuration for %s was not standard: an untouched copy of %s has been kept at %s. Please check, validate and correct the new configuration at %s.",
124 fromFilterName, fromFilterNode.getHandle() + "/clientCallback", fromFilterNode.getHandle() + "/_clientCallback_backup_config", newCallbacksNode.getHandle()
125 ));
126
127 }
128 }
129
130 private void addCallback(InstallContext ctx, Content target, String givenCallbackName, Content source, String urlPattern) throws RepositoryException {
131 final String clazz = source.getNodeData("class").getString();
132 final String newName;
133 if (givenCallbackName == null && contains(SIMPLE_CALLBACK_CLASSES, clazz)) {
134 newName = simplifyClassName(clazz);
135 } else if (givenCallbackName != null) {
136 newName = givenCallbackName;
137 } else {
138 log.warn("Can not determine name for callback at {}", source.getHandle());
139 wereWeAbleToUpdateEverything = false;
140 return;
141 }
142
143 final Content newCallback = target.createContent(newName, NodeTypes.ContentNode.NAME);
144 copyStringProperty(source, newCallback, "class");
145 if (FORM_CLASS.equals(clazz)) {
146 copyStringProperty(source, newCallback, "loginForm");
147 logAndIgnore(ctx, source, "realmName");
148 checkRemainingProperties(ctx, source, "class", "loginForm", "realmName");
149 } else if (REDIRECT_CLASS.equals(clazz)) {
150 copyStringProperty(source, newCallback, "location");
151 logAndIgnore(ctx, source, "realmName");
152 checkRemainingProperties(ctx, source, "class", "location", "realmName");
153 } else if (BASIC_CLASS.equals(clazz)) {
154 copyStringProperty(source, newCallback, "realmName");
155 checkRemainingProperties(ctx, source, "class", "realmName");
156 } else {
157 log.warn("Unknown callback class: {}; copying all properties.", clazz);
158 wereWeAbleToUpdateEverything = false;
159 copyRemainingProperties(ctx, source, newCallback, "class");
160 }
161
162 if (urlPattern != null) {
163 Content urlPatternContent = newCallback.createContent("urlPattern", NodeTypes.ContentNode.NAME);
164 urlPatternContent.setNodeData("class", "info.magnolia.cms.util.SimpleUrlPattern");
165 urlPatternContent.setNodeData("patternString", urlPattern);
166 }
167
168 }
169
170 private String simplifyClassName(String clazz) {
171 return StringUtils.removeEnd(StringUtils.substringAfterLast(clazz, "."), "ClientCallback").toLowerCase();
172 }
173
174 private void copyStringProperty(Content source, Content target, String propertyName) throws RepositoryException {
175 target.setNodeData(propertyName, source.getNodeData(propertyName).getString());
176 }
177
178
179
180
181 private void logAndIgnore(InstallContext ctx, Content source, String propertyName) throws RepositoryException {
182 if (source.hasNodeData(propertyName)) {
183 ctx.warn(source.getHandle() + " has a '" + propertyName + "' property; it is ignored and has been removed.");
184 }
185 }
186
187
188
189
190 private void checkRemainingProperties(InstallContext ctx, Content source, String... ignoredProperties) {
191 final Set<String> ignoredPropsSet = Sets.newHashSet(ignoredProperties);
192 final Collection<NodeData> allProps = source.getNodeDataCollection();
193 final Iterable<String> allPropsNames = Iterables.transform(allProps, new Function<NodeData, String>() {
194 @Override
195 public String apply(NodeData from) {
196 return from.getName();
197 }
198 });
199 final Iterable<String> remaining = Iterables.filter(allPropsNames, Predicates.not(Predicates.in(ignoredPropsSet)));
200 if (!Iterables.isEmpty(remaining)) {
201 log.warn("{} has the following unknown properties which were not copied: {}", source.getHandle(), remaining);
202 wereWeAbleToUpdateEverything = false;
203 }
204 }
205
206 private void copyRemainingProperties(InstallContext ctx, Content source, Content target, String... ignoredProperties) throws RepositoryException {
207 final Collection<NodeData> existingProps = source.getNodeDataCollection();
208 for (NodeData prop : existingProps) {
209 if (ArrayUtils.contains(ignoredProperties, prop.getName())) {
210 continue;
211 }
212 copyStringProperty(source, target, prop.getName());
213 }
214 }
215
216 }