]> git.argeo.org Git - gpl/argeo-suite.git/blob - core/org.argeo.suite.ui/src/org/argeo/suite/ui/SuiteApp.java
Introduce DocBook 4 converter.
[gpl/argeo-suite.git] / core / org.argeo.suite.ui / src / org / argeo / suite / ui / SuiteApp.java
1 package org.argeo.suite.ui;
2
3 import static org.argeo.cms.ui.CmsView.CMS_VIEW_UID_PROPERTY;
4
5 import java.util.Collections;
6 import java.util.HashMap;
7 import java.util.HashSet;
8 import java.util.List;
9 import java.util.Locale;
10 import java.util.Map;
11 import java.util.Set;
12 import java.util.TreeMap;
13 import java.util.TreeSet;
14
15 import javax.jcr.Node;
16 import javax.jcr.RepositoryException;
17 import javax.jcr.Session;
18 import javax.jcr.nodetype.NodeType;
19 import javax.naming.InvalidNameException;
20 import javax.naming.ldap.LdapName;
21
22 import org.apache.commons.logging.Log;
23 import org.apache.commons.logging.LogFactory;
24 import org.argeo.api.NodeUtils;
25 import org.argeo.cms.CmsUserManager;
26 import org.argeo.cms.LocaleUtils;
27 import org.argeo.cms.Localized;
28 import org.argeo.cms.auth.CmsSession;
29 import org.argeo.cms.ui.AbstractCmsApp;
30 import org.argeo.cms.ui.CmsTheme;
31 import org.argeo.cms.ui.CmsUiProvider;
32 import org.argeo.cms.ui.CmsView;
33 import org.argeo.cms.ui.dialogs.CmsFeedback;
34 import org.argeo.cms.ui.util.CmsUiUtils;
35 import org.argeo.eclipse.ui.specific.UiContext;
36 import org.argeo.entity.EntityConstants;
37 import org.argeo.entity.EntityNames;
38 import org.argeo.entity.EntityType;
39 import org.argeo.jcr.Jcr;
40 import org.argeo.jcr.JcrException;
41 import org.argeo.suite.RankedObject;
42 import org.argeo.suite.SuiteUtils;
43 import org.argeo.util.LangUtils;
44 import org.eclipse.swt.SWT;
45 import org.eclipse.swt.widgets.Composite;
46 import org.osgi.framework.Constants;
47 import org.osgi.service.event.Event;
48 import org.osgi.service.event.EventHandler;
49 import org.osgi.service.useradmin.User;
50
51 /** The Argeo Suite App. */
52 public class SuiteApp extends AbstractCmsApp implements EventHandler {
53 private final static Log log = LogFactory.getLog(SuiteApp.class);
54
55 public final static String PUBLIC_BASE_PATH_PROPERTY = "publicBasePath";
56 public final static String DEFAULT_UI_NAME_PROPERTY = "defaultUiName";
57 public final static String DEFAULT_THEME_ID_PROPERTY = "defaultThemeId";
58 private final static String LOGIN = "login";
59
60 private String publicBasePath = null;
61
62 private String pidPrefix;
63 private String headerPid;
64 private String footerPid;
65 private String leadPanePid;
66 private String loginScreenPid;
67
68 private String defaultLayerPid = "argeo.suite.ui.dashboardLayer";
69
70 private String defaultUiName = "app";
71 private String defaultThemeId = "org.argeo.suite.theme.default";
72
73 private Map<String, RankedObject<CmsUiProvider>> uiProvidersByPid = Collections.synchronizedMap(new HashMap<>());
74 private Map<String, RankedObject<CmsUiProvider>> uiProvidersByType = Collections.synchronizedMap(new HashMap<>());
75 private Map<String, RankedObject<SuiteLayer>> layersByPid = Collections.synchronizedSortedMap(new TreeMap<>());
76 private Map<String, RankedObject<SuiteLayer>> layersByType = Collections.synchronizedSortedMap(new TreeMap<>());
77
78 private CmsUserManager cmsUserManager;
79
80 // TODO make more optimal or via CmsSession/CmsView
81 private Map<String, SuiteUi> managedUis = new HashMap<>();
82
83 public void init(Map<String, Object> properties) {
84 if (log.isDebugEnabled())
85 log.info("Argeo Suite App started");
86
87 if (properties.containsKey(DEFAULT_UI_NAME_PROPERTY))
88 defaultUiName = LangUtils.get(properties, DEFAULT_UI_NAME_PROPERTY);
89 if (properties.containsKey(DEFAULT_THEME_ID_PROPERTY))
90 defaultThemeId = LangUtils.get(properties, DEFAULT_THEME_ID_PROPERTY);
91 publicBasePath = LangUtils.get(properties, PUBLIC_BASE_PATH_PROPERTY);
92
93 if (properties.containsKey(Constants.SERVICE_PID)) {
94 String servicePid = properties.get(Constants.SERVICE_PID).toString();
95 if (servicePid.endsWith(".app")) {
96 pidPrefix = servicePid.substring(0, servicePid.length() - "app".length());
97 }
98 }
99
100 if (pidPrefix == null)
101 throw new IllegalArgumentException("PID prefix must be set.");
102
103 headerPid = pidPrefix + "header";
104 footerPid = pidPrefix + "footer";
105 leadPanePid = pidPrefix + "leadPane";
106 loginScreenPid = pidPrefix + "loginScreen";
107 }
108
109 public void destroy(Map<String, Object> properties) {
110 for (SuiteUi ui : managedUis.values())
111 if (!ui.isDisposed())
112 ui.dispose();
113 if (log.isDebugEnabled())
114 log.info("Argeo Suite App stopped");
115
116 }
117
118 @Override
119 public Set<String> getUiNames() {
120 HashSet<String> uiNames = new HashSet<>();
121 uiNames.add(defaultUiName);
122 return uiNames;
123 }
124
125 @Override
126 public Composite initUi(Composite parent) {
127 String uiName = parent.getData(UI_NAME_PROPERTY) != null ? parent.getData(UI_NAME_PROPERTY).toString() : null;
128 CmsView cmsView = CmsView.getCmsView(parent);
129 if (cmsView == null)
130 throw new IllegalStateException("No CMS view is registered.");
131 CmsTheme theme = getTheme(uiName);
132 if (theme != null)
133 CmsTheme.registerCmsTheme(parent.getShell(), theme);
134 SuiteUi argeoSuiteUi = new SuiteUi(parent, SWT.INHERIT_DEFAULT);
135 String uid = cmsView.getUid();
136 managedUis.put(uid, argeoSuiteUi);
137 argeoSuiteUi.addDisposeListener((e) -> {
138 managedUis.remove(uid);
139 if (log.isDebugEnabled())
140 log.debug("Suite UI " + uid + " has been disposed.");
141 });
142 return argeoSuiteUi;
143 }
144
145 @Override
146 public String getThemeId(String uiName) {
147 return defaultThemeId;
148 }
149
150 @Override
151 public void refreshUi(Composite parent, String state) {
152 try {
153 Node context = null;
154 SuiteUi ui = (SuiteUi) parent;
155 CmsView cmsView = CmsView.getCmsView(parent);
156 CmsUiProvider headerUiProvider = findUiProvider(headerPid);
157 CmsUiProvider footerUiProvider = findUiProvider(footerPid);
158 Localized appTitle = null;
159 if (headerUiProvider instanceof DefaultHeader) {
160 appTitle = ((DefaultHeader) headerUiProvider).getTitle();
161 }
162 ui.setTitle(appTitle);
163
164 if (cmsView.isAnonymous() && publicBasePath == null) {// internal app, must login
165 ui.logout();
166 if (headerUiProvider != null)
167 refreshPart(headerUiProvider, ui.getHeader(), context);
168 ui.refreshBelowHeader(false);
169 refreshPart(findUiProvider(loginScreenPid), ui.getBelowHeader(), context);
170 if (footerUiProvider != null)
171 refreshPart(footerUiProvider, ui.getFooter(), context);
172 ui.layout(true, true);
173 setState(ui, LOGIN);
174 } else {
175 if (LOGIN.equals(state))
176 state = null;
177 CmsSession cmsSession = cmsView.getCmsSession();
178 if (ui.getUserDir() == null) {
179 // FIXME NPE on CMSSession when logging in from anonymous
180 if (cmsSession == null || cmsView.isAnonymous()) {
181 assert publicBasePath != null;
182 ui.initSessions(getRepository(), publicBasePath);
183 } else {
184 Session adminSession = null;
185 try {
186 adminSession = NodeUtils.openDataAdminSession(getRepository(), null);
187 Node userDir = SuiteUtils.getOrCreateCmsSessionNode(adminSession, cmsSession);
188 ui.initSessions(getRepository(), userDir.getPath());
189 } finally {
190 Jcr.logout(adminSession);
191 }
192 }
193 }
194 initLocale(cmsSession);
195 context = stateToNode(ui, state);
196 if (context == null)
197 context = ui.getUserDir();
198
199 if (headerUiProvider != null)
200 refreshPart(headerUiProvider, ui.getHeader(), context);
201 ui.refreshBelowHeader(true);
202 for (String key : layersByPid.keySet()) {
203 SuiteLayer layer = layersByPid.get(key).get();
204 ui.addLayer(key, layer);
205 }
206 refreshPart(findUiProvider(leadPanePid), ui.getLeadPane(), context);
207 if (footerUiProvider != null)
208 refreshPart(footerUiProvider, ui.getFooter(), context);
209 ui.layout(true, true);
210 setState(parent, state != null ? state : defaultLayerPid);
211 }
212 } catch (Exception e) {
213 CmsFeedback.show("Unexpected exception", e);
214 }
215 }
216
217 private void initLocale(CmsSession cmsSession) {
218 if (cmsSession == null)
219 return;
220 Locale locale = cmsSession.getLocale();
221 UiContext.setLocale(locale);
222 LocaleUtils.setThreadLocale(locale);
223
224 }
225
226 private void refreshPart(CmsUiProvider uiProvider, Composite part, Node context) {
227 CmsUiUtils.clear(part);
228 uiProvider.createUiPart(part, context);
229 }
230
231 private CmsUiProvider findUiProvider(String pid) {
232 if (!uiProvidersByPid.containsKey(pid))
233 return null;
234 return uiProvidersByPid.get(pid).get();
235 }
236
237 private SuiteLayer findLayer(String pid) {
238 if (!layersByPid.containsKey(pid))
239 return null;
240 return layersByPid.get(pid).get();
241 }
242
243 private <T> T findByType(Map<String, RankedObject<T>> byType, Node context) {
244 if (context == null)
245 throw new IllegalArgumentException("A node should be provided");
246 try {
247 // mixins
248 Set<String> types = new TreeSet<>();
249 for (NodeType mixinType : context.getMixinNodeTypes()) {
250 String mixinTypeName = mixinType.getName();
251 if (byType.containsKey(mixinTypeName)) {
252 types.add(mixinTypeName);
253 }
254 for (NodeType superType : mixinType.getDeclaredSupertypes()) {
255 if (byType.containsKey(superType.getName())) {
256 types.add(superType.getName());
257 }
258 }
259 }
260 // primary node type
261 NodeType primaryType = context.getPrimaryNodeType();
262 String primaryTypeName = primaryType.getName();
263 if (byType.containsKey(primaryTypeName)) {
264 types.add(primaryTypeName);
265 }
266 for (NodeType superType : primaryType.getDeclaredSupertypes()) {
267 if (byType.containsKey(superType.getName())) {
268 types.add(superType.getName());
269 }
270 }
271 // entity type
272 if (context.isNodeType(EntityType.entity.get())) {
273 if (context.hasProperty(EntityNames.ENTITY_TYPE)) {
274 String entityTypeName = context.getProperty(EntityNames.ENTITY_TYPE).getString();
275 if (byType.containsKey(entityTypeName)) {
276 types.add(entityTypeName);
277 }
278 }
279 }
280
281 // if (context.getPath().equals("/")) {// root node
282 // types.add("nt:folder");
283 // }
284 if (NodeUtils.isUserHome(context) && byType.containsKey("nt:folder")) {// home node
285 types.add("nt:folder");
286 }
287
288 if (types.size() == 0)
289 throw new IllegalArgumentException("No type found for " + context + " (" + listTypes(context) + ")");
290 String type = types.iterator().next();
291 if (!byType.containsKey(type))
292 throw new IllegalArgumentException("No component found for " + context + " with type " + type);
293 return byType.get(type).get();
294 } catch (RepositoryException e) {
295 throw new IllegalStateException(e);
296 }
297 }
298
299 private static String listTypes(Node context) {
300 try {
301 StringBuilder sb = new StringBuilder();
302 sb.append(context.getPrimaryNodeType().getName());
303 for (NodeType superType : context.getPrimaryNodeType().getDeclaredSupertypes()) {
304 sb.append(' ');
305 sb.append(superType.getName());
306 }
307
308 for (NodeType nodeType : context.getMixinNodeTypes()) {
309 sb.append(' ');
310 sb.append(nodeType.getName());
311 if (nodeType.getName().equals(EntityType.local.get()))
312 sb.append('/').append(context.getProperty(EntityNames.ENTITY_TYPE).getString());
313 for (NodeType superType : nodeType.getDeclaredSupertypes()) {
314 sb.append(' ');
315 sb.append(superType.getName());
316 }
317 }
318 return sb.toString();
319 } catch (RepositoryException e) {
320 throw new JcrException(e);
321 }
322 }
323
324 @Override
325 public void setState(Composite parent, String state) {
326 if (state == null)
327 return;
328 if (!state.startsWith("/")) {
329 if (parent instanceof SuiteUi) {
330 SuiteUi ui = (SuiteUi) parent;
331 if (LOGIN.equals(state) || state.equals("~")) {
332 String appTitle = "";
333 if (ui.getTitle() != null)
334 appTitle = ui.getTitle().lead();
335 ui.getCmsView().stateChanged(state, appTitle);
336 return;
337 }
338 String currentLayerId = ui.getCurrentLayerId();
339 if (state.equals(currentLayerId))
340 return; // does nothing
341 else {
342 Map<String, Object> properties = new HashMap<>();
343 properties.put(SuiteEvent.LAYER, state);
344 ui.getCmsView().sendEvent(SuiteEvent.switchLayer.topic(), properties);
345 }
346 }
347 return;
348 }
349 SuiteUi suiteUi = (SuiteUi) parent;
350 Node node = stateToNode(suiteUi, state);
351 if (node == null) {
352 suiteUi.getCmsView().navigateTo("~");
353 } else {
354 suiteUi.getCmsView().sendEvent(SuiteEvent.switchLayer.topic(), SuiteEvent.eventProperties(node));
355 suiteUi.getCmsView().sendEvent(SuiteEvent.refreshPart.topic(), SuiteEvent.eventProperties(node));
356 }
357 }
358
359 private String nodeToState(Node node) {
360 return '/' + Jcr.getWorkspaceName(node) + Jcr.getPath(node);
361 }
362
363 private Node stateToNode(SuiteUi suiteUi, String state) {
364 if (suiteUi == null)
365 return null;
366 if (state == null || !state.startsWith("/"))
367 return null;
368
369 String path = state.substring(1);
370 String workspace;
371 if (path.equals("")) {
372 workspace = null;
373 path = "/";
374 } else {
375 int index = path.indexOf('/');
376 if (index == 0) {
377 log.error("Cannot interpret " + state);
378 // cmsView.navigateTo("~");
379 return null;
380 } else if (index > 0) {
381 workspace = path.substring(0, index);
382 path = path.substring(index);
383 } else {// index<0, assuming root node
384 workspace = path;
385 path = "/";
386 }
387 }
388 Session session = suiteUi.getSession(workspace);
389 if (session == null)
390 return null;
391 Node node = Jcr.getNode(session, path);
392 return node;
393 }
394
395 /*
396 * Events management
397 */
398
399 @Override
400 public void handleEvent(Event event) {
401
402 // Specific UI related events
403 SuiteUi ui = getRelatedUi(event);
404 if (ui == null)
405 return;
406 try {
407 String appTitle = "";
408 if (ui.getTitle() != null)
409 appTitle = ui.getTitle().lead() + " - ";
410
411 // String currentLayerId = ui.getCurrentLayerId();
412 // SuiteLayer currentLayer = currentLayerId != null ? layersByPid.get(currentLayerId).get() : null;
413 if (SuiteUiUtils.isTopic(event, SuiteEvent.refreshPart)) {
414 Node node = getNode(ui, event);
415 if (node == null)
416 return;
417 CmsUiProvider uiProvider = findByType(uiProvidersByType, node);
418 SuiteLayer layer = findByType(layersByType, node);
419 ui.switchToLayer(layer, node);
420 ui.getCmsView().runAs(() -> layer.view(uiProvider, ui.getCurrentWorkArea(), node));
421 ui.getCmsView().stateChanged(nodeToState(node), appTitle + Jcr.getTitle(node));
422 } else if (SuiteUiUtils.isTopic(event, SuiteEvent.openNewPart)) {
423 Node node = getNode(ui, event);
424 if (node == null)
425 return;
426 CmsUiProvider uiProvider = findByType(uiProvidersByType, node);
427 SuiteLayer layer = findByType(layersByType, node);
428 ui.switchToLayer(layer, node);
429 ui.getCmsView().runAs(() -> layer.open(uiProvider, ui.getCurrentWorkArea(), node));
430 ui.getCmsView().stateChanged(nodeToState(node), appTitle + Jcr.getTitle(node));
431 } else if (SuiteUiUtils.isTopic(event, SuiteEvent.switchLayer)) {
432 String layerId = get(event, SuiteEvent.LAYER);
433 if (layerId != null) {
434 // ui.switchToLayer(layerId, ui.getUserDir());
435 SuiteLayer suiteLayer = findLayer(layerId);
436 Localized layerTitle = suiteLayer.getTitle();
437 ui.getCmsView().runAs(() -> ui.switchToLayer(layerId, ui.getUserDir()));
438 String title = null;
439 if (layerTitle != null)
440 title = layerTitle.lead();
441 ui.getCmsView().stateChanged(layerId, appTitle + title);
442 } else {
443 Node node = getNode(ui, event);
444 if (node != null) {
445 SuiteLayer layer = findByType(layersByType, node);
446 ui.getCmsView().runAs(() -> ui.switchToLayer(layer, node));
447 }
448 }
449 }
450 } catch (Exception e) {
451 log.error("Cannot handle event " + event, e);
452 // CmsView.getCmsView(ui).exception(e);
453 }
454
455 }
456
457 private Node getNode(SuiteUi ui, Event event) {
458 String nodePath = get(event, SuiteEvent.NODE_PATH);
459 String workspaceName = get(event, SuiteEvent.WORKSPACE);
460 Session session = ui.getSession(workspaceName);
461 Node node;
462 if (nodePath == null) {
463 // look for a user
464 String username = get(event, SuiteEvent.USERNAME);
465 if (username == null)
466 return null;
467 User user = cmsUserManager.getUser(username);
468 if (user == null)
469 return null;
470 LdapName userDn;
471 try {
472 userDn = new LdapName(user.getName());
473 } catch (InvalidNameException e) {
474 throw new IllegalArgumentException("Badly formatted username", e);
475 }
476 String userNodePath = SuiteUtils.getUserNodePath(userDn);
477 if (Jcr.itemExists(session, userNodePath))
478 node = Jcr.getNode(session, userNodePath);
479 else {
480 Session adminSession = null;
481 try {
482 adminSession = NodeUtils.openDataAdminSession(getRepository(), workspaceName);
483 SuiteUtils.getOrCreateUserNode(adminSession, userDn);
484 } finally {
485 Jcr.logout(adminSession);
486 }
487 node = Jcr.getNode(session, userNodePath);
488 }
489 } else {
490 node = Jcr.getNode(session, nodePath);
491 }
492 return node;
493 }
494
495 private SuiteUi getRelatedUi(Event event) {
496 return managedUis.get(get(event, CMS_VIEW_UID_PROPERTY));
497 }
498
499 public static String get(Event event, String key) {
500 Object value = event.getProperty(key);
501 if (value == null)
502 return null;
503 // throw new IllegalArgumentException("Property " + key + " must be set");
504 return value.toString();
505
506 }
507
508 /*
509 * Dependency injection.
510 */
511
512 public void addUiProvider(CmsUiProvider uiProvider, Map<String, Object> properties) {
513 if (properties.containsKey(Constants.SERVICE_PID)) {
514 String pid = (String) properties.get(Constants.SERVICE_PID);
515 RankedObject.putIfHigherRank(uiProvidersByPid, pid, uiProvider, properties);
516 }
517 if (properties.containsKey(EntityConstants.TYPE)) {
518 List<String> types = LangUtils.toStringList(properties.get(EntityConstants.TYPE));
519 for (String type : types)
520 RankedObject.putIfHigherRank(uiProvidersByType, type, uiProvider, properties);
521 }
522 }
523
524 public void removeUiProvider(CmsUiProvider uiProvider, Map<String, Object> properties) {
525 if (properties.containsKey(Constants.SERVICE_PID)) {
526 String pid = (String) properties.get(Constants.SERVICE_PID);
527 if (uiProvidersByPid.containsKey(pid)) {
528 if (uiProvidersByPid.get(pid).equals(new RankedObject<CmsUiProvider>(uiProvider, properties))) {
529 uiProvidersByPid.remove(pid);
530 }
531 }
532 }
533 if (properties.containsKey(EntityConstants.TYPE)) {
534 List<String> types = LangUtils.toStringList(properties.get(EntityConstants.TYPE));
535 for (String type : types) {
536 if (uiProvidersByType.containsKey(type)) {
537 if (uiProvidersByType.get(type).equals(new RankedObject<CmsUiProvider>(uiProvider, properties))) {
538 uiProvidersByType.remove(type);
539 }
540 }
541 }
542 }
543 }
544
545 public void addLayer(SuiteLayer layer, Map<String, Object> properties) {
546 if (properties.containsKey(Constants.SERVICE_PID)) {
547 String pid = (String) properties.get(Constants.SERVICE_PID);
548 RankedObject.putIfHigherRank(layersByPid, pid, layer, properties);
549 }
550 if (properties.containsKey(EntityConstants.TYPE)) {
551 List<String> types = LangUtils.toStringList(properties.get(EntityConstants.TYPE));
552 for (String type : types)
553 RankedObject.putIfHigherRank(layersByType, type, layer, properties);
554 }
555 }
556
557 public void removeLayer(SuiteLayer layer, Map<String, Object> properties) {
558 if (properties.containsKey(Constants.SERVICE_PID)) {
559 String pid = (String) properties.get(Constants.SERVICE_PID);
560 if (layersByPid.containsKey(pid)) {
561 if (layersByPid.get(pid).equals(new RankedObject<SuiteLayer>(layer, properties))) {
562 layersByPid.remove(pid);
563 }
564 }
565 }
566 if (properties.containsKey(EntityConstants.TYPE)) {
567 List<String> types = LangUtils.toStringList(properties.get(EntityConstants.TYPE));
568 for (String type : types) {
569 if (layersByType.containsKey(type)) {
570 if (layersByType.get(type).equals(new RankedObject<CmsUiProvider>(layer, properties))) {
571 layersByType.remove(type);
572 }
573 }
574 }
575 }
576 }
577
578 public void setCmsUserManager(CmsUserManager cmsUserManager) {
579 this.cmsUserManager = cmsUserManager;
580 }
581
582 }