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.ui.vaadin.gwt.client.connector;
35
36 import info.magnolia.ui.vaadin.editor.PageEditor;
37 import info.magnolia.ui.vaadin.gwt.client.css.PageEditorCssProvider;
38 import info.magnolia.ui.vaadin.gwt.client.editor.dom.CmsNode;
39 import info.magnolia.ui.vaadin.gwt.client.editor.dom.Comment;
40 import info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlComponent;
41 import info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlElement;
42 import info.magnolia.ui.vaadin.gwt.client.editor.dom.processor.AbstractMgnlElementProcessor;
43 import info.magnolia.ui.vaadin.gwt.client.editor.dom.processor.CommentProcessor;
44 import info.magnolia.ui.vaadin.gwt.client.editor.dom.processor.ElementProcessor;
45 import info.magnolia.ui.vaadin.gwt.client.editor.dom.processor.MgnlElementProcessorFactory;
46 import info.magnolia.ui.vaadin.gwt.client.editor.dom.processor.ProcessException;
47 import info.magnolia.ui.vaadin.gwt.client.editor.event.ComponentActionEvent;
48 import info.magnolia.ui.vaadin.gwt.client.editor.event.ComponentStartMoveEvent;
49 import info.magnolia.ui.vaadin.gwt.client.editor.event.ComponentStopMoveEvent;
50 import info.magnolia.ui.vaadin.gwt.client.editor.event.EditAreaEvent;
51 import info.magnolia.ui.vaadin.gwt.client.editor.event.EditComponentEvent;
52 import info.magnolia.ui.vaadin.gwt.client.editor.event.FrameNavigationEvent;
53 import info.magnolia.ui.vaadin.gwt.client.editor.event.NewAreaEvent;
54 import info.magnolia.ui.vaadin.gwt.client.editor.event.NewComponentEvent;
55 import info.magnolia.ui.vaadin.gwt.client.editor.event.SelectElementEvent;
56 import info.magnolia.ui.vaadin.gwt.client.editor.event.SortComponentEvent;
57 import info.magnolia.ui.vaadin.gwt.client.editor.jsni.event.FrameLoadedEvent;
58 import info.magnolia.ui.vaadin.gwt.client.editor.jsni.event.RefreshEvent;
59 import info.magnolia.ui.vaadin.gwt.client.editor.model.Model;
60 import info.magnolia.ui.vaadin.gwt.client.editor.model.ModelImpl;
61 import info.magnolia.ui.vaadin.gwt.client.editor.model.focus.FocusModel;
62 import info.magnolia.ui.vaadin.gwt.client.editor.model.focus.FocusModelImpl;
63 import info.magnolia.ui.vaadin.gwt.client.rpc.PageEditorClientRpc;
64 import info.magnolia.ui.vaadin.gwt.client.rpc.PageEditorServerRpc;
65 import info.magnolia.ui.vaadin.gwt.client.shared.AbstractElement;
66 import info.magnolia.ui.vaadin.gwt.client.shared.AreaElement;
67 import info.magnolia.ui.vaadin.gwt.client.shared.ComponentElement;
68 import info.magnolia.ui.vaadin.gwt.client.shared.PageElement;
69 import info.magnolia.ui.vaadin.gwt.client.widget.PageEditorView;
70 import info.magnolia.ui.vaadin.gwt.client.widget.PageEditorViewImpl;
71 import info.magnolia.ui.vaadin.gwt.client.widget.dnd.MoveWidget;
72
73 import java.util.ArrayList;
74 import java.util.List;
75 import java.util.logging.Logger;
76
77 import com.google.gwt.core.client.GWT;
78 import com.google.gwt.core.client.JavaScriptException;
79 import com.google.gwt.dom.client.Document;
80 import com.google.gwt.dom.client.Element;
81 import com.google.gwt.dom.client.HeadElement;
82 import com.google.gwt.dom.client.LinkElement;
83 import com.google.gwt.dom.client.Node;
84 import com.google.gwt.dom.client.NodeList;
85 import com.google.gwt.event.shared.EventBus;
86 import com.google.gwt.event.shared.SimpleEventBus;
87 import com.google.gwt.regexp.shared.MatchResult;
88 import com.google.gwt.regexp.shared.RegExp;
89 import com.google.gwt.user.client.ui.Widget;
90 import com.vaadin.client.BrowserInfo;
91 import com.vaadin.client.communication.RpcProxy;
92 import com.vaadin.client.communication.StateChangeEvent;
93 import com.vaadin.client.ui.AbstractComponentConnector;
94 import com.vaadin.shared.ui.Connect;
95
96
97
98
99 @Connect(PageEditor.class)
100 public class PageEditorConnector extends AbstractComponentConnector implements PageEditorView.Listener {
101
102 private Logger log = Logger.getLogger(getClass().getName());
103
104 private static final String IFRAME_PRELOADER_STYLE = "iframe-preloader";
105
106 private final PageEditorServerRpc rpc = RpcProxy.create(PageEditorServerRpc.class, this);
107
108 private final EventBus eventBus = new SimpleEventBus();
109
110 private PageEditorView view;
111 private MoveWidget moveWidget;
112
113 private Model model;
114
115 private FocusModel focusModel;
116 private ElementProcessor elementProcessor;
117 private CommentProcessor commentProcessor;
118
119
120
121
122
123
124 private boolean pageChange = false;
125
126 @Override
127 protected void init() {
128 super.init();
129 this.model = new ModelImpl();
130 this.focusModel = new FocusModelImpl(eventBus, model);
131 this.elementProcessor = new ElementProcessor(eventBus, model);
132 this.commentProcessor = new CommentProcessor();
133
134 addStateChangeHandler("url", (StateChangeEvent.StateChangeHandler) stateChangeEvent -> {
135 view.setUrl(getState().getUrl());
136 if (getState().isPreview()) {
137 view.getFrame().addStyleName(IFRAME_PRELOADER_STYLE);
138 }
139 });
140 registerRpc(PageEditorClientRpc.class, new PageEditorClientRpc() {
141
142 @Override
143 public void refresh() {
144 view.reload();
145 }
146
147 @Override
148 public void startMoveComponent(ComponentElement moveComponent) {
149 MgnlElement selectedElement = model.getMgnlElement(moveComponent);
150 if (selectedElement != null && selectedElement.isComponent()) {
151 MgnlComponent./../../../info/magnolia/ui/vaadin/gwt/client/editor/dom/MgnlComponent.html#MgnlComponent">MgnlComponent component = (MgnlComponent) selectedElement;
152 component.doStartMove(false);
153 model.setMoving(true);
154 if (!BrowserInfo.get().isTouchDevice()) {
155 PageEditorConnector.this.moveWidget = component.getMoveWidget();
156 moveWidget.attach(view.getFrame());
157 }
158 }
159 }
160
161 @Override
162 public void cancelMoveComponent() {
163 eventBus.fireEvent(new ComponentStopMoveEvent(null, true));
164 }
165 });
166
167
168
169
170
171 eventBus.addHandler(FrameLoadedEvent.TYPE, event -> {
172 model.reset();
173 focusModel.resetFocus();
174 Document document = null;
175 try {
176 document = event.getFrame().getContentDocument();
177 } catch (JavaScriptException e) {
178 GWT.log("Error getting content document from iframe: " + e.getMessage());
179 }
180 if (document == null) {
181 rpc.selectExternalPage();
182 } else {
183 process(document);
184
185 view.initKeyEventListeners();
186
187 if (!getState().isPreview()) {
188 view.initDomEventListeners();
189 focusModel.init();
190 }
191 AbstractElement elementToSelect = pageChange ? null : getState().getSelectedElement();
192 try {
193 focusModel.selectElement(elementToSelect);
194 } catch (JavaScriptException e) {
195 GWT.log("Cannot select element: " + e.getMessage());
196 }
197 }
198 PageEditorConnector.this.pageChange = false;
199
200 if (event.getFrame() != null) {
201 rpc.onNavigation(removePageEditorParameters(event.getFrame().getUrl()));
202 }
203 });
204
205 eventBus.addHandler(RefreshEvent.TYPE, event -> {
206 focusModel.resetFocus();
207 model.reset();
208 Document document = view.getFrame().getContentDocument();
209 process(document);
210 if (!getState().isPreview()) {
211 focusModel.init();
212 }
213 focusModel.selectElement(getState().getSelectedElement());
214 });
215
216 eventBus.addHandler(FrameNavigationEvent.TYPE, frameUrlChangedEvent -> {
217 String path = frameUrlChangedEvent.getPath();
218 RegExp regExp = RegExp.compile("((?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*))(?:(\\?[^#]*))?(?:(#.*))?");
219 MatchResult matchResult = regExp.exec(path);
220 if (matchResult != null) {
221 path = matchResult.getGroup(1);
222
223 final String platformId = getState().getPlatformType().getId();
224 final boolean isPreview = getState().isPreview();
225 String query = matchResult.getGroup(5);
226 query = query != null ? removePageEditorParameters(query) : query;
227 query = query != null && query != "" ? query + "&" : "?";
228 query += "mgnlChannel=" + platformId;
229 query += "&mgnlPreview=" + isPreview;
230 path += query;
231
232 String fragment = matchResult.getGroup(6);
233 if (fragment != null) {
234 path += fragment;
235 }
236 }
237
238 PageEditorConnector.this.pageChange = true;
239 view.setUrl(path);
240 });
241
242 eventBus.addHandler(SelectElementEvent.TYPE, selectElementEvent -> {
243 AbstractElement selectedElement = selectElementEvent.getElement();
244 if (selectedElement instanceof PageElement) {
245 rpc.selectPage((PageElement) selectedElement);
246 } else if (selectedElement instanceof AreaElement) {
247 rpc.selectArea((AreaElement) selectedElement);
248 } else if (selectedElement instanceof ComponentElement) {
249 rpc.selectComponent((ComponentElement) selectedElement);
250 }
251 view.resetScrollTop();
252 });
253
254 eventBus.addHandler(NewAreaEvent.TYPE, newAreaEvent -> {
255 if (!getConnection().getMessageSender().hasActiveRequest()) {
256 rpc.newArea(newAreaEvent.getAreaElement());
257 }
258 });
259
260 eventBus.addHandler(NewComponentEvent.TYPE, newComponentEvent -> {
261 if (!getConnection().getMessageSender().hasActiveRequest()) {
262 rpc.newComponent(newComponentEvent.getParentAreaElement());
263 }
264 });
265
266 eventBus.addHandler(EditAreaEvent.TYPE, editAreaEvent -> {
267 if (!getConnection().getMessageSender().hasActiveRequest()) {
268 rpc.editArea(editAreaEvent.getAreaElement());
269 }
270 });
271
272 eventBus.addHandler(EditComponentEvent.TYPE, editComponentEvent -> {
273 if (!getConnection().getMessageSender().hasActiveRequest()) {
274 rpc.editComponent(editComponentEvent.getComponentElement());
275 }
276 });
277
278 eventBus.addHandler(SortComponentEvent.TYPE, sortComponentEvent -> rpc.sortComponent(sortComponentEvent.getAreaElement()));
279
280 eventBus.addHandler(ComponentStartMoveEvent.TYPE, componentStartMoveEvent -> rpc.startMoveComponent(componentStartMoveEvent.getComponentElement()));
281
282 eventBus.addHandler(ComponentStopMoveEvent.TYPE, componentStopMoveEvent -> {
283 if (!componentStopMoveEvent.isServerSide()) {
284 rpc.stopMoveComponent();
285 }
286 if (moveWidget != null && moveWidget.isAttached()) {
287 moveWidget.detach();
288 }
289 model.setMoving(false);
290 });
291
292 eventBus.addHandler(ComponentActionEvent.TYPE, actionEvent -> rpc.onClientAction(actionEvent.getElement(), actionEvent.getActionName(), actionEvent.getParameters()));
293 }
294
295 @Override
296 protected Widget createWidget() {
297 this.view = new PageEditorViewImpl(eventBus);
298 this.view.setListener(this);
299 return view.asWidget();
300 }
301
302 @Override
303 public PageEditorState getState() {
304 return (PageEditorState) super.getState();
305 }
306
307 @Override
308 public void selectElement(Element element) {
309 focusModel.selectElement(element);
310 }
311
312 private void process(final Document document) {
313 try {
314 injectEditorStyles(document);
315 long startTime = System.currentTimeMillis();
316 processDocument(document, null);
317 processMgnlElements();
318 GWT.log("Time spent to process cms comments: " + (System.currentTimeMillis() - startTime) + "ms");
319 } catch (ProcessException e) {
320 rpc.onError(e.getErrorType(), e.getTagName());
321 GWT.log("Error while processing comment: " + e.getTagName() + " due to " + e.getErrorType());
322 consoleLog("Error while processing comment: " + e.getTagName() + " due to " + e.getErrorType());
323 }
324 }
325
326 private void injectEditorStyles(final Document document) {
327 HeadElement head = HeadElement.as(document.getElementsByTagName("head").getItem(0));
328 final NodeList<Node> childNodes = head.getChildNodes();
329 List<String> urls = new ArrayList<>();
330 for(int i = 0; i < childNodes.getLength(); i++) {
331 if (!(childNodes.getItem(i) instanceof LinkElement)) {
332 continue;
333 }
334 String url = ((LinkElement) childNodes.getItem(i)).getHref();
335 if (url != null) {
336 urls.add(url);
337 }
338 }
339 for (String uri: PageEditorCssProvider.INSTANCE.getCssLinks()) {
340 if (urls.stream().anyMatch(url -> url.contains(uri))) {
341 continue;
342 }
343 LinkElement cssLink = createLinkElement(document, getState().getContextPath() + uri);
344 head.insertFirst(cssLink);
345 }
346 }
347
348 private LinkElement createLinkElement(final Document document, final String href) {
349 LinkElement cssLink = document.createLinkElement();
350 cssLink.setType("text/css");
351 cssLink.setRel("stylesheet");
352 cssLink.setHref(href);
353 return cssLink;
354 }
355
356 private void processDocument(Node node, MgnlElement mgnlElement) throws ProcessException {
357 if (mgnlElement == null && model.getRootPage() != null) {
358 mgnlElement = model.getRootPage();
359 }
360 for (int i = 0; i < node.getChildCount(); i++) {
361 Node childNode = node.getChild(i);
362 if (childNode.getNodeType() == Comment.COMMENT_NODE) {
363 try {
364 mgnlElement = commentProcessor.process(model, eventBus, childNode, mgnlElement);
365 } catch (ProcessException e) {
366 throw e;
367 } catch (IllegalArgumentException e) {
368 GWT.log("Not CMSComment element, skipping: " + e.toString());
369 } catch (Exception e) {
370 GWT.log("Caught undefined exception: " + e.toString());
371 consoleLog("Caught undefined exception: " + e.toString());
372 }
373 } else if (childNode.getNodeType() == Node.ELEMENT_NODE) {
374 Element element = childNode.cast();
375 elementProcessor.process(element, mgnlElement, getState().isPreview());
376 }
377 processDocument(childNode, mgnlElement);
378 }
379 }
380
381 private void processMgnlElements() {
382 CmsNode root = model.getRootPage();
383 if (model.getRootPage() == null) {
384 log.warning("Could not find any Magnolia cms:page tag, this might be a static page; not injecting page-editor bars.");
385 return;
386 }
387
388 List<CmsNode> elements = root.getDescendants();
389 elements.add(root);
390 for (CmsNode element : elements) {
391 try {
392 AbstractMgnlElementProcessor processor = MgnlElementProcessorFactory.getProcessor(model, element.asMgnlElement(), getState().getI18nKeys());
393 processor.process();
394 } catch (IllegalArgumentException e) {
395 GWT.log("MgnlFactory could not instantiate class. The element is neither an area nor component.");
396 } catch (Exception e) {
397 final String errorMessage = "Error when processing editor components for '" + element.asMgnlElement().getAttribute("path") +
398 "'. It's possible that the template script for this area or for some subcomponent is incorrect. Please check that all HTML tags are closed properly.\n"
399 + e.toString();
400 GWT.log(errorMessage);
401 consoleLog(errorMessage);
402 }
403 }
404 }
405
406 void consoleLog(String message) {
407 log.info("PageEditor: " + message);
408 }
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424 private String removePageEditorParameters(String url) {
425 return url.replaceAll("(\\&{0,1})(mgnlChannel|mgnlPreview)\\=([^&]+)", "").replaceAll("(\\?$)", "").replaceAll("(\\?\\&)", "?");
426 }
427 }