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.editor.dom.CmsNode;
38 import info.magnolia.ui.vaadin.gwt.client.editor.dom.Comment;
39 import info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlComponent;
40 import info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlElement;
41 import info.magnolia.ui.vaadin.gwt.client.editor.dom.processor.AbstractMgnlElementProcessor;
42 import info.magnolia.ui.vaadin.gwt.client.editor.dom.processor.CommentProcessor;
43 import info.magnolia.ui.vaadin.gwt.client.editor.dom.processor.ElementProcessor;
44 import info.magnolia.ui.vaadin.gwt.client.editor.dom.processor.MgnlElementProcessorFactory;
45 import info.magnolia.ui.vaadin.gwt.client.editor.dom.processor.ProcessException;
46 import info.magnolia.ui.vaadin.gwt.client.editor.event.ComponentStartMoveEvent;
47 import info.magnolia.ui.vaadin.gwt.client.editor.event.ComponentStopMoveEvent;
48 import info.magnolia.ui.vaadin.gwt.client.editor.event.EditAreaEvent;
49 import info.magnolia.ui.vaadin.gwt.client.editor.event.EditAreaEventHandler;
50 import info.magnolia.ui.vaadin.gwt.client.editor.event.EditComponentEvent;
51 import info.magnolia.ui.vaadin.gwt.client.editor.event.EditComponentEventHandler;
52 import info.magnolia.ui.vaadin.gwt.client.editor.event.FrameNavigationEvent;
53 import info.magnolia.ui.vaadin.gwt.client.editor.event.FrameNavigationEventHandler;
54 import info.magnolia.ui.vaadin.gwt.client.editor.event.NewAreaEvent;
55 import info.magnolia.ui.vaadin.gwt.client.editor.event.NewAreaEventHandler;
56 import info.magnolia.ui.vaadin.gwt.client.editor.event.NewComponentEvent;
57 import info.magnolia.ui.vaadin.gwt.client.editor.event.NewComponentEventHandler;
58 import info.magnolia.ui.vaadin.gwt.client.editor.event.SelectElementEvent;
59 import info.magnolia.ui.vaadin.gwt.client.editor.event.SelectElementEventHandler;
60 import info.magnolia.ui.vaadin.gwt.client.editor.event.SortComponentEvent;
61 import info.magnolia.ui.vaadin.gwt.client.editor.event.SortComponentEventHandler;
62 import info.magnolia.ui.vaadin.gwt.client.editor.jsni.event.FrameLoadedEvent;
63 import info.magnolia.ui.vaadin.gwt.client.editor.model.Model;
64 import info.magnolia.ui.vaadin.gwt.client.editor.model.ModelImpl;
65 import info.magnolia.ui.vaadin.gwt.client.editor.model.focus.FocusModel;
66 import info.magnolia.ui.vaadin.gwt.client.editor.model.focus.FocusModelImpl;
67 import info.magnolia.ui.vaadin.gwt.client.rpc.PageEditorClientRpc;
68 import info.magnolia.ui.vaadin.gwt.client.rpc.PageEditorServerRpc;
69 import info.magnolia.ui.vaadin.gwt.client.shared.AbstractElement;
70 import info.magnolia.ui.vaadin.gwt.client.shared.AreaElement;
71 import info.magnolia.ui.vaadin.gwt.client.shared.ComponentElement;
72 import info.magnolia.ui.vaadin.gwt.client.shared.PageEditorParameters;
73 import info.magnolia.ui.vaadin.gwt.client.shared.PageElement;
74 import info.magnolia.ui.vaadin.gwt.client.widget.PageEditorView;
75 import info.magnolia.ui.vaadin.gwt.client.widget.PageEditorViewImpl;
76 import info.magnolia.ui.vaadin.gwt.client.widget.dnd.MoveWidget;
77
78 import java.util.List;
79 import java.util.logging.Logger;
80
81 import com.google.gwt.core.client.GWT;
82 import com.google.gwt.core.client.JavaScriptException;
83 import com.google.gwt.dom.client.Document;
84 import com.google.gwt.dom.client.Element;
85 import com.google.gwt.dom.client.HeadElement;
86 import com.google.gwt.dom.client.LinkElement;
87 import com.google.gwt.dom.client.Node;
88 import com.google.gwt.event.shared.EventBus;
89 import com.google.gwt.event.shared.SimpleEventBus;
90 import com.google.gwt.user.client.DOM;
91 import com.google.gwt.user.client.ui.Widget;
92 import com.vaadin.client.BrowserInfo;
93 import com.vaadin.client.communication.RpcProxy;
94 import com.vaadin.client.communication.StateChangeEvent;
95 import com.vaadin.client.communication.StateChangeEvent.StateChangeHandler;
96 import com.vaadin.client.ui.AbstractComponentConnector;
97 import com.vaadin.shared.ui.Connect;
98
99
100
101
102 @Connect(PageEditor.class)
103 public class PageEditorConnector extends AbstractComponentConnector implements PageEditorView.Listener {
104
105 private Logger log = Logger.getLogger(getClass().getName());
106
107 private static final String PAGE_EDITOR_CSS = "/VAADIN/themes/ui-app-pages/page-editor.css";
108
109 private final PageEditorServerRpc rpc = RpcProxy.create(PageEditorServerRpc.class, this);
110
111 private final EventBus eventBus = new SimpleEventBus();
112
113 private PageEditorView view;
114 private MoveWidget moveWidget;
115
116 private Model model;
117
118 private FocusModel focusModel;
119 private ElementProcessor elementProcessor;
120 private CommentProcessor commentProcessor;
121
122 @Override
123 protected void init() {
124 super.init();
125 this.model = new ModelImpl();
126 this.focusModel = new FocusModelImpl(eventBus, model);
127 this.elementProcessor = new ElementProcessor(eventBus, model);
128 this.commentProcessor = new CommentProcessor();
129
130 addStateChangeHandler(new StateChangeHandler() {
131 @Override
132 public void onStateChanged(StateChangeEvent stateChangeEvent) {
133 PageEditorParameters params = getState().parameters;
134 view.setUrl(params.getUrl());
135 if (params.isPreview()) {
136 view.getFrame().addStyleName("iframe-preloader");
137 }
138 }
139 });
140
141 registerRpc(PageEditorClientRpc.class, new PageEditorClientRpc() {
142
143 @Override
144 public void refresh() {
145 view.reload();
146 }
147
148 @Override
149 public void startMoveComponent() {
150 MgnlComponent component = focusModel.getSelectedComponent();
151 if (component != null) {
152 component.doStartMove(false);
153 model.setMoving(true);
154 if (!BrowserInfo.get().isTouchDevice()) {
155 Element element = DOM.clone(focusModel.getSelectedComponent().getControlBar().getElement(), true);
156 moveWidget = new MoveWidget(element);
157 moveWidget.attach(view.getFrame(), component.getWidth(), component.getHeight());
158 }
159 }
160 }
161
162 @Override
163 public void cancelMoveComponent() {
164 eventBus.fireEvent(new ComponentStopMoveEvent(null, true));
165 }
166 });
167
168 eventBus.addHandler(FrameLoadedEvent.TYPE, new FrameLoadedEvent.Handler() {
169 @Override
170 public void handle(FrameLoadedEvent event) {
171 model.reset();
172 Document document = null;
173 try {
174 document = event.getFrame().getContentDocument();
175 } catch (JavaScriptException e) {
176 GWT.log("Error getting content document from iframe: " + e.getMessage());
177 }
178 if (document == null) {
179 rpc.selectExternalPage();
180 } else {
181 process(document);
182
183 view.initKeyEventListeners();
184
185 if (!getState().parameters.isPreview()) {
186 view.initDomEventListeners();
187 focusModel.init();
188 } else {
189 focusModel.clearSelection();
190 }
191 }
192 }
193 });
194
195 eventBus.addHandler(FrameNavigationEvent.TYPE, new FrameNavigationEventHandler() {
196 @Override
197 public void onFrameUrlChanged(FrameNavigationEvent frameUrlChangedEvent) {
198 String path = frameUrlChangedEvent.getPath();
199
200 final String platformId = getState().parameters.getPlatformType().getId();
201 path += path.indexOf('?') == -1 ? "?" : "&";
202 path += "mgnlChannel=" + platformId;
203
204 final boolean isPreview = getState().parameters.isPreview();
205 path += "&mgnlPreview=" + isPreview;
206
207 view.setUrl(path);
208 }
209 });
210
211 eventBus.addHandler(SelectElementEvent.TYPE, new SelectElementEventHandler() {
212 @Override
213 public void onSelectElement(SelectElementEvent selectElementEvent) {
214 AbstractElement selectedElement = selectElementEvent.getElement();
215 if (selectedElement instanceof PageElement) {
216 rpc.selectPage((PageElement) selectedElement);
217 }
218 else if (selectedElement instanceof AreaElement) {
219 rpc.selectArea((AreaElement) selectedElement);
220 }
221 else if (selectedElement instanceof ComponentElement) {
222 rpc.selectComponent((ComponentElement) selectedElement);
223 }
224 view.resetScrollTop();
225 }
226 });
227
228 eventBus.addHandler(NewAreaEvent.TYPE, new NewAreaEventHandler() {
229 @Override
230 public void onNewArea(NewAreaEvent newAreaEvent) {
231 rpc.newArea(newAreaEvent.getAreaElement());
232 }
233 });
234
235 eventBus.addHandler(NewComponentEvent.TYPE, new NewComponentEventHandler() {
236 @Override
237 public void onNewComponent(NewComponentEvent newComponentEvent) {
238 rpc.newComponent(newComponentEvent.getParentAreaElement());
239 }
240 });
241
242 eventBus.addHandler(EditAreaEvent.TYPE, new EditAreaEventHandler() {
243 @Override
244 public void onEditArea(EditAreaEvent editAreaEvent) {
245 rpc.editArea(editAreaEvent.getAreaElement());
246 }
247 });
248
249 eventBus.addHandler(EditComponentEvent.TYPE, new EditComponentEventHandler() {
250 @Override
251 public void onEditComponent(EditComponentEvent editComponentEvent) {
252 rpc.editComponent(editComponentEvent.getComponentElement());
253 }
254 });
255
256 eventBus.addHandler(SortComponentEvent.TYPE, new SortComponentEventHandler() {
257 @Override
258 public void onSortComponent(SortComponentEvent sortComponentEvent) {
259 rpc.sortComponent(sortComponentEvent.getAreaElement());
260 }
261 });
262
263 eventBus.addHandler(ComponentStartMoveEvent.TYPE, new ComponentStartMoveEvent.CompnentStartMoveEventHandler() {
264 @Override
265 public void onStart(ComponentStartMoveEvent componentStartMoveEvent) {
266 rpc.startMoveComponent();
267 }
268 });
269
270 eventBus.addHandler(ComponentStopMoveEvent.TYPE, new ComponentStopMoveEvent.ComponentStopMoveEventHandler() {
271 @Override
272 public void onStop(ComponentStopMoveEvent componentStopMoveEvent) {
273 if (!componentStopMoveEvent.isServerSide()) {
274 rpc.stopMoveComponent();
275 }
276 if (moveWidget != null && moveWidget.isAttached()) {
277 moveWidget.detach();
278 }
279 model.setMoving(false);
280 }
281 });
282
283 }
284
285 @Override
286 protected Widget createWidget() {
287 this.view = new PageEditorViewImpl(eventBus);
288 this.view.setListener(this);
289 return view.asWidget();
290 }
291
292 @Override
293 public PageEditorState getState() {
294 return (PageEditorState) super.getState();
295 }
296
297 @Override
298 public void selectElement(Element element) {
299 focusModel.selectElement(model.getMgnlElement(element));
300 }
301
302 private void process(final Document document) {
303 try {
304 injectEditorStyles(document);
305 long startTime = System.currentTimeMillis();
306 processDocument(document, null);
307 processMgnlElements();
308 GWT.log("Time spent to process cms comments: " + (System.currentTimeMillis() - startTime) + "ms");
309 } catch (ProcessException e) {
310 rpc.onError(e.getErrorType(), e.getTagName());
311 GWT.log("Error while processing comment: " + e.getTagName() + " due to " + e.getErrorType());
312 consoleLog("Error while processing comment: " + e.getTagName() + " due to " + e.getErrorType());
313 }
314 }
315
316 private void injectEditorStyles(final Document document) {
317 HeadElement head = HeadElement.as(document.getElementsByTagName("head").getItem(0));
318 LinkElement cssLink = document.createLinkElement();
319 cssLink.setType("text/css");
320 cssLink.setRel("stylesheet");
321 cssLink.setHref(getState().parameters.getContextPath() + PAGE_EDITOR_CSS);
322 head.insertFirst(cssLink);
323 }
324
325 private void processDocument(Node node, MgnlElement mgnlElement) throws ProcessException {
326 if (mgnlElement == null && model.getRootPage() != null) {
327 mgnlElement = model.getRootPage();
328 }
329 for (int i = 0; i < node.getChildCount(); i++) {
330 Node childNode = node.getChild(i);
331 if (childNode.getNodeType() == Comment.COMMENT_NODE) {
332 try {
333 mgnlElement = commentProcessor.process(model, eventBus, childNode, mgnlElement);
334 } catch (ProcessException e) {
335 throw e;
336 } catch (IllegalArgumentException e) {
337 GWT.log("Not CMSComment element, skipping: " + e.toString());
338 } catch (Exception e) {
339 GWT.log("Caught undefined exception: " + e.toString());
340 consoleLog("Caught undefined exception: " + e.toString());
341 }
342 } else if (childNode.getNodeType() == Node.ELEMENT_NODE) {
343 Element element = childNode.cast();
344 elementProcessor.process(element, mgnlElement, getState().parameters.isPreview());
345 }
346 processDocument(childNode, mgnlElement);
347 }
348 }
349
350 private void processMgnlElements() {
351 CmsNode root = model.getRootPage();
352 if (model.getRootPage() == null) {
353 log.warning("Could not find any Magnolia cms:page tag, this might be a static page; not injecting page-editor bars.");
354 return;
355 }
356
357 List<CmsNode> elements = root.getDescendants();
358 elements.add(root);
359 for (CmsNode element : elements) {
360 try {
361 AbstractMgnlElementProcessor processor = MgnlElementProcessorFactory.getProcessor(model, element.asMgnlElement());
362 processor.process();
363 } catch (IllegalArgumentException e) {
364 GWT.log("MgnlFactory could not instantiate class. The element is neither an area nor component.");
365 } catch (Exception e) {
366 final String errorMessage = "Error when processing editor components for '" + element.asMgnlElement().getAttribute("path") +
367 "'. 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"
368 + e.toString();
369 GWT.log(errorMessage);
370 consoleLog(errorMessage);
371 }
372 }
373 }
374
375 void consoleLog(String message) {
376 log.info("PageEditor: " + message);
377 }
378 }