1 package org
.argeo
.suite
.ui
;
3 import static org
.argeo
.cms
.ui
.CmsView
.CMS_VIEW_UID_PROPERTY
;
5 import java
.util
.Collections
;
6 import java
.util
.HashMap
;
7 import java
.util
.HashSet
;
9 import java
.util
.Locale
;
11 import java
.util
.Objects
;
13 import java
.util
.TreeMap
;
14 import java
.util
.TreeSet
;
16 import javax
.jcr
.Node
;
17 import javax
.jcr
.RepositoryException
;
18 import javax
.jcr
.Session
;
19 import javax
.jcr
.nodetype
.NodeType
;
20 import javax
.naming
.InvalidNameException
;
21 import javax
.naming
.ldap
.LdapName
;
23 import org
.apache
.commons
.logging
.Log
;
24 import org
.apache
.commons
.logging
.LogFactory
;
25 import org
.argeo
.api
.NodeUtils
;
26 import org
.argeo
.cms
.CmsUserManager
;
27 import org
.argeo
.cms
.LocaleUtils
;
28 import org
.argeo
.cms
.Localized
;
29 import org
.argeo
.cms
.auth
.CmsSession
;
30 import org
.argeo
.cms
.ui
.AbstractCmsApp
;
31 import org
.argeo
.cms
.ui
.CmsTheme
;
32 import org
.argeo
.cms
.ui
.CmsUiProvider
;
33 import org
.argeo
.cms
.ui
.CmsView
;
34 import org
.argeo
.cms
.ui
.dialogs
.CmsFeedback
;
35 import org
.argeo
.cms
.ui
.util
.CmsUiUtils
;
36 import org
.argeo
.eclipse
.ui
.specific
.UiContext
;
37 import org
.argeo
.entity
.EntityConstants
;
38 import org
.argeo
.entity
.EntityNames
;
39 import org
.argeo
.entity
.EntityType
;
40 import org
.argeo
.jcr
.Jcr
;
41 import org
.argeo
.jcr
.JcrException
;
42 import org
.argeo
.suite
.RankedObject
;
43 import org
.argeo
.suite
.SuiteUtils
;
44 import org
.argeo
.util
.LangUtils
;
45 import org
.eclipse
.swt
.SWT
;
46 import org
.eclipse
.swt
.widgets
.Composite
;
47 import org
.osgi
.framework
.Constants
;
48 import org
.osgi
.service
.event
.Event
;
49 import org
.osgi
.service
.event
.EventHandler
;
50 import org
.osgi
.service
.useradmin
.User
;
52 /** The Argeo Suite App. */
53 public class SuiteApp
extends AbstractCmsApp
implements EventHandler
{
54 private final static Log log
= LogFactory
.getLog(SuiteApp
.class);
56 public final static String PUBLIC_BASE_PATH_PROPERTY
= "publicBasePath";
57 public final static String DEFAULT_UI_NAME_PROPERTY
= "defaultUiName";
58 public final static String DEFAULT_THEME_ID_PROPERTY
= "defaultThemeId";
59 public final static String DEFAULT_LAYER_PROPERTY
= "defaultLayer";
60 private final static String LOGIN
= "login";
61 private final static String HOME_STATE
= "~";
63 private String publicBasePath
= null;
65 private String pidPrefix
;
66 private String headerPid
;
67 private String footerPid
;
68 private String leadPanePid
;
69 private String adminLeadPanePid
;
70 private String loginScreenPid
;
72 private String defaultLayerPid
= "argeo.suite.ui.dashboardLayer";
74 private String defaultUiName
= "app";
75 private String adminUiName
= "admin";
76 private String defaultThemeId
= "org.argeo.suite.theme.default";
78 private Map
<String
, RankedObject
<CmsUiProvider
>> uiProvidersByPid
= Collections
.synchronizedMap(new HashMap
<>());
79 private Map
<String
, RankedObject
<CmsUiProvider
>> uiProvidersByType
= Collections
.synchronizedMap(new HashMap
<>());
80 private Map
<String
, RankedObject
<SuiteLayer
>> layersByPid
= Collections
.synchronizedSortedMap(new TreeMap
<>());
81 private Map
<String
, RankedObject
<SuiteLayer
>> layersByType
= Collections
.synchronizedSortedMap(new TreeMap
<>());
83 private CmsUserManager cmsUserManager
;
85 // TODO make more optimal or via CmsSession/CmsView
86 private Map
<String
, SuiteUi
> managedUis
= new HashMap
<>();
88 public void init(Map
<String
, Object
> properties
) {
89 if (log
.isDebugEnabled())
90 log
.info("Argeo Suite App started");
92 if (properties
.containsKey(DEFAULT_UI_NAME_PROPERTY
))
93 defaultUiName
= LangUtils
.get(properties
, DEFAULT_UI_NAME_PROPERTY
);
94 if (properties
.containsKey(DEFAULT_THEME_ID_PROPERTY
))
95 defaultThemeId
= LangUtils
.get(properties
, DEFAULT_THEME_ID_PROPERTY
);
96 if (properties
.containsKey(DEFAULT_LAYER_PROPERTY
))
97 defaultLayerPid
= LangUtils
.get(properties
, DEFAULT_LAYER_PROPERTY
);
98 publicBasePath
= LangUtils
.get(properties
, PUBLIC_BASE_PATH_PROPERTY
);
100 if (properties
.containsKey(Constants
.SERVICE_PID
)) {
101 String servicePid
= properties
.get(Constants
.SERVICE_PID
).toString();
102 if (servicePid
.endsWith(".app")) {
103 pidPrefix
= servicePid
.substring(0, servicePid
.length() - "app".length());
107 if (pidPrefix
== null)
108 throw new IllegalArgumentException("PID prefix must be set.");
110 headerPid
= pidPrefix
+ "header";
111 footerPid
= pidPrefix
+ "footer";
112 leadPanePid
= pidPrefix
+ "leadPane";
113 adminLeadPanePid
= pidPrefix
+ "adminLeadPane";
114 loginScreenPid
= pidPrefix
+ "loginScreen";
117 public void destroy(Map
<String
, Object
> properties
) {
118 for (SuiteUi ui
: managedUis
.values())
119 if (!ui
.isDisposed())
121 if (log
.isDebugEnabled())
122 log
.info("Argeo Suite App stopped");
127 public Set
<String
> getUiNames() {
128 HashSet
<String
> uiNames
= new HashSet
<>();
129 uiNames
.add(defaultUiName
);
130 uiNames
.add(adminUiName
);
135 public Composite
initUi(Composite parent
) {
136 String uiName
= parent
.getData(UI_NAME_PROPERTY
) != null ? parent
.getData(UI_NAME_PROPERTY
).toString() : null;
137 CmsView cmsView
= CmsView
.getCmsView(parent
);
139 throw new IllegalStateException("No CMS view is registered.");
140 CmsTheme theme
= getTheme(uiName
);
142 CmsTheme
.registerCmsTheme(parent
.getShell(), theme
);
143 SuiteUi argeoSuiteUi
= new SuiteUi(parent
, SWT
.INHERIT_DEFAULT
);
144 String uid
= cmsView
.getUid();
145 managedUis
.put(uid
, argeoSuiteUi
);
146 argeoSuiteUi
.addDisposeListener((e
) -> {
147 managedUis
.remove(uid
);
148 if (log
.isDebugEnabled())
149 log
.debug("Suite UI " + uid
+ " has been disposed.");
155 public String
getThemeId(String uiName
) {
156 return defaultThemeId
;
160 public void refreshUi(Composite parent
, String state
) {
163 SuiteUi ui
= (SuiteUi
) parent
;
165 String uiName
= Objects
.toString(ui
.getParent().getData(UI_NAME_PROPERTY
), null);
167 throw new IllegalStateException("UI name should not be null");
168 CmsView cmsView
= CmsView
.getCmsView(parent
);
169 CmsUiProvider headerUiProvider
= findUiProvider(headerPid
);
170 CmsUiProvider footerUiProvider
= findUiProvider(footerPid
);
171 CmsUiProvider leadPaneUiProvider
;
172 if (adminUiName
.equals(uiName
)) {
173 leadPaneUiProvider
= findUiProvider(adminLeadPanePid
);
175 leadPaneUiProvider
= findUiProvider(leadPanePid
);
178 Localized appTitle
= null;
179 if (headerUiProvider
instanceof DefaultHeader
) {
180 appTitle
= ((DefaultHeader
) headerUiProvider
).getTitle();
182 ui
.setTitle(appTitle
);
184 if (cmsView
.isAnonymous() && publicBasePath
== null) {// internal app, must login
186 if (headerUiProvider
!= null)
187 refreshPart(headerUiProvider
, ui
.getHeader(), context
);
188 ui
.refreshBelowHeader(false);
189 refreshPart(findUiProvider(loginScreenPid
), ui
.getBelowHeader(), context
);
190 if (footerUiProvider
!= null)
191 refreshPart(footerUiProvider
, ui
.getFooter(), context
);
192 ui
.layout(true, true);
195 if (LOGIN
.equals(state
))
197 CmsSession cmsSession
= cmsView
.getCmsSession();
198 if (ui
.getUserDir() == null) {
199 // FIXME NPE on CMSSession when logging in from anonymous
200 if (cmsSession
== null || cmsView
.isAnonymous()) {
201 assert publicBasePath
!= null;
202 ui
.initSessions(getRepository(), publicBasePath
);
204 Session adminSession
= null;
206 adminSession
= NodeUtils
.openDataAdminSession(getRepository(), null);
207 Node userDir
= SuiteUtils
.getOrCreateCmsSessionNode(adminSession
, cmsSession
);
208 ui
.initSessions(getRepository(), userDir
.getPath());
210 Jcr
.logout(adminSession
);
214 initLocale(cmsSession
);
215 context
= stateToNode(ui
, state
);
217 context
= ui
.getUserDir();
219 if (headerUiProvider
!= null)
220 refreshPart(headerUiProvider
, ui
.getHeader(), context
);
221 ui
.refreshBelowHeader(true);
222 for (String key
: layersByPid
.keySet()) {
223 SuiteLayer layer
= layersByPid
.get(key
).get();
224 ui
.addLayer(key
, layer
);
227 if (leadPaneUiProvider
!= null)
228 refreshPart(leadPaneUiProvider
, ui
.getLeadPane(), context
);
229 if (footerUiProvider
!= null)
230 refreshPart(footerUiProvider
, ui
.getFooter(), context
);
231 ui
.layout(true, true);
232 setState(parent
, state
!= null ? state
: defaultLayerPid
);
234 } catch (Exception e
) {
235 CmsFeedback
.show("Unexpected exception", e
);
239 private void initLocale(CmsSession cmsSession
) {
240 if (cmsSession
== null)
242 Locale locale
= cmsSession
.getLocale();
243 UiContext
.setLocale(locale
);
244 LocaleUtils
.setThreadLocale(locale
);
248 private void refreshPart(CmsUiProvider uiProvider
, Composite part
, Node context
) {
249 CmsUiUtils
.clear(part
);
250 uiProvider
.createUiPart(part
, context
);
253 private CmsUiProvider
findUiProvider(String pid
) {
254 if (!uiProvidersByPid
.containsKey(pid
))
256 return uiProvidersByPid
.get(pid
).get();
259 private SuiteLayer
findLayer(String pid
) {
260 if (!layersByPid
.containsKey(pid
))
262 return layersByPid
.get(pid
).get();
265 private <T
> T
findByType(Map
<String
, RankedObject
<T
>> byType
, Node context
) {
267 throw new IllegalArgumentException("A node should be provided");
270 Set
<String
> types
= new TreeSet
<>();
271 for (NodeType mixinType
: context
.getMixinNodeTypes()) {
272 String mixinTypeName
= mixinType
.getName();
273 if (byType
.containsKey(mixinTypeName
)) {
274 types
.add(mixinTypeName
);
276 for (NodeType superType
: mixinType
.getDeclaredSupertypes()) {
277 if (byType
.containsKey(superType
.getName())) {
278 types
.add(superType
.getName());
283 NodeType primaryType
= context
.getPrimaryNodeType();
284 String primaryTypeName
= primaryType
.getName();
285 if (byType
.containsKey(primaryTypeName
)) {
286 types
.add(primaryTypeName
);
288 for (NodeType superType
: primaryType
.getDeclaredSupertypes()) {
289 if (byType
.containsKey(superType
.getName())) {
290 types
.add(superType
.getName());
294 if (context
.isNodeType(EntityType
.entity
.get())) {
295 if (context
.hasProperty(EntityNames
.ENTITY_TYPE
)) {
296 String entityTypeName
= context
.getProperty(EntityNames
.ENTITY_TYPE
).getString();
297 if (byType
.containsKey(entityTypeName
)) {
298 types
.add(entityTypeName
);
303 // if (context.getPath().equals("/")) {// root node
304 // types.add("nt:folder");
306 if (NodeUtils
.isUserHome(context
) && byType
.containsKey("nt:folder")) {// home node
307 types
.add("nt:folder");
310 if (types
.size() == 0)
311 throw new IllegalArgumentException("No type found for " + context
+ " (" + listTypes(context
) + ")");
312 String type
= types
.iterator().next();
313 if (!byType
.containsKey(type
))
314 throw new IllegalArgumentException("No component found for " + context
+ " with type " + type
);
315 return byType
.get(type
).get();
316 } catch (RepositoryException e
) {
317 throw new IllegalStateException(e
);
321 private static String
listTypes(Node context
) {
323 StringBuilder sb
= new StringBuilder();
324 sb
.append(context
.getPrimaryNodeType().getName());
325 for (NodeType superType
: context
.getPrimaryNodeType().getDeclaredSupertypes()) {
327 sb
.append(superType
.getName());
330 for (NodeType nodeType
: context
.getMixinNodeTypes()) {
332 sb
.append(nodeType
.getName());
333 if (nodeType
.getName().equals(EntityType
.local
.get()))
334 sb
.append('/').append(context
.getProperty(EntityNames
.ENTITY_TYPE
).getString());
335 for (NodeType superType
: nodeType
.getDeclaredSupertypes()) {
337 sb
.append(superType
.getName());
340 return sb
.toString();
341 } catch (RepositoryException e
) {
342 throw new JcrException(e
);
347 public void setState(Composite parent
, String state
) {
350 if (!state
.startsWith("/")) {
351 if (parent
instanceof SuiteUi
) {
352 SuiteUi ui
= (SuiteUi
) parent
;
353 if (LOGIN
.equals(state
)) {
354 String appTitle
= "";
355 if (ui
.getTitle() != null)
356 appTitle
= ui
.getTitle().lead();
357 ui
.getCmsView().stateChanged(state
, appTitle
);
360 Map
<String
, Object
> properties
= new HashMap
<>();
361 String layerId
= HOME_STATE
.equals(state
) ? defaultLayerPid
: state
;
362 properties
.put(SuiteEvent
.LAYER
, layerId
);
363 properties
.put(SuiteEvent
.NODE_PATH
, HOME_STATE
);
364 ui
.getCmsView().sendEvent(SuiteEvent
.switchLayer
.topic(), properties
);
368 SuiteUi suiteUi
= (SuiteUi
) parent
;
369 Node node
= stateToNode(suiteUi
, state
);
371 suiteUi
.getCmsView().navigateTo(HOME_STATE
);
373 suiteUi
.getCmsView().sendEvent(SuiteEvent
.switchLayer
.topic(), SuiteEvent
.eventProperties(node
));
374 suiteUi
.getCmsView().sendEvent(SuiteEvent
.refreshPart
.topic(), SuiteEvent
.eventProperties(node
));
378 // TODO move it to an internal package?
379 static String
nodeToState(Node node
) {
380 return '/' + Jcr
.getWorkspaceName(node
) + Jcr
.getPath(node
);
383 private Node
stateToNode(SuiteUi suiteUi
, String state
) {
386 if (state
== null || !state
.startsWith("/"))
389 String path
= state
.substring(1);
391 if (path
.equals("")) {
395 int index
= path
.indexOf('/');
397 log
.error("Cannot interpret " + state
);
398 // cmsView.navigateTo("~");
400 } else if (index
> 0) {
401 workspace
= path
.substring(0, index
);
402 path
= path
.substring(index
);
403 } else {// index<0, assuming root node
408 Session session
= suiteUi
.getSession(workspace
);
411 Node node
= Jcr
.getNode(session
, path
);
420 public void handleEvent(Event event
) {
422 // Specific UI related events
423 SuiteUi ui
= getRelatedUi(event
);
427 String appTitle
= "";
428 if (ui
.getTitle() != null)
429 appTitle
= ui
.getTitle().lead() + " - ";
431 // String currentLayerId = ui.getCurrentLayerId();
432 // SuiteLayer currentLayer = currentLayerId != null ? layersByPid.get(currentLayerId).get() : null;
433 if (SuiteUiUtils
.isTopic(event
, SuiteEvent
.refreshPart
)) {
434 Node node
= getNode(ui
, event
);
437 CmsUiProvider uiProvider
= findByType(uiProvidersByType
, node
);
438 SuiteLayer layer
= findByType(layersByType
, node
);
439 ui
.switchToLayer(layer
, node
);
440 ui
.getCmsView().runAs(() -> layer
.view(uiProvider
, ui
.getCurrentWorkArea(), node
));
441 ui
.getCmsView().stateChanged(nodeToState(node
), appTitle
+ Jcr
.getTitle(node
));
442 } else if (SuiteUiUtils
.isTopic(event
, SuiteEvent
.openNewPart
)) {
443 Node node
= getNode(ui
, event
);
446 CmsUiProvider uiProvider
= findByType(uiProvidersByType
, node
);
447 SuiteLayer layer
= findByType(layersByType
, node
);
448 ui
.switchToLayer(layer
, node
);
449 ui
.getCmsView().runAs(() -> layer
.open(uiProvider
, ui
.getCurrentWorkArea(), node
));
450 ui
.getCmsView().stateChanged(nodeToState(node
), appTitle
+ Jcr
.getTitle(node
));
451 } else if (SuiteUiUtils
.isTopic(event
, SuiteEvent
.switchLayer
)) {
452 String layerId
= get(event
, SuiteEvent
.LAYER
);
453 if (layerId
!= null) {
454 // ui.switchToLayer(layerId, ui.getUserDir());
455 SuiteLayer suiteLayer
= findLayer(layerId
);
456 if (suiteLayer
== null)
457 throw new IllegalArgumentException("No layer '" + layerId
+ "' available.");
458 Localized layerTitle
= suiteLayer
.getTitle();
459 // FIXME make sure we don't rebuild the work area twice
460 Composite workArea
= ui
.getCmsView().doAs(() -> ui
.switchToLayer(layerId
, ui
.getUserDir()));
462 if (layerTitle
!= null)
463 title
= layerTitle
.lead();
464 Node nodeFromState
= getNode(ui
, event
);
465 if (nodeFromState
!= null && nodeFromState
.getPath().equals(ui
.getUserDir().getPath())) {
466 // default layer view is forced
467 String state
= defaultLayerPid
.equals(layerId
) ?
"~" : layerId
;
468 ui
.getCmsView().stateChanged(state
, appTitle
+ title
);
469 suiteLayer
.view(null, workArea
, nodeFromState
);
471 Node layerCurrentContext
= suiteLayer
.getCurrentContext(workArea
);
472 if (layerCurrentContext
!= null) {
473 // layer was already showing a context so we set the state to it
474 ui
.getCmsView().stateChanged(nodeToState(layerCurrentContext
),
475 appTitle
+ Jcr
.getTitle(layerCurrentContext
));
477 // no context was shown
478 ui
.getCmsView().stateChanged(layerId
, appTitle
+ title
);
482 Node node
= getNode(ui
, event
);
484 SuiteLayer layer
= findByType(layersByType
, node
);
485 ui
.getCmsView().runAs(() -> ui
.switchToLayer(layer
, node
));
489 } catch (Exception e
) {
490 log
.error("Cannot handle event " + event
, e
);
491 // CmsView.getCmsView(ui).exception(e);
496 private Node
getNode(SuiteUi ui
, Event event
) {
497 String nodePath
= get(event
, SuiteEvent
.NODE_PATH
);
498 if (nodePath
!= null && nodePath
.equals(HOME_STATE
))
499 return ui
.getUserDir();
500 String workspaceName
= get(event
, SuiteEvent
.WORKSPACE
);
501 Session session
= ui
.getSession(workspaceName
);
503 if (nodePath
== null) {
505 String username
= get(event
, SuiteEvent
.USERNAME
);
506 if (username
== null)
508 User user
= cmsUserManager
.getUser(username
);
513 userDn
= new LdapName(user
.getName());
514 } catch (InvalidNameException e
) {
515 throw new IllegalArgumentException("Badly formatted username", e
);
517 String userNodePath
= SuiteUtils
.getUserNodePath(userDn
);
518 if (Jcr
.itemExists(session
, userNodePath
))
519 node
= Jcr
.getNode(session
, userNodePath
);
521 Session adminSession
= null;
523 adminSession
= NodeUtils
.openDataAdminSession(getRepository(), workspaceName
);
524 SuiteUtils
.getOrCreateUserNode(adminSession
, userDn
);
526 Jcr
.logout(adminSession
);
528 node
= Jcr
.getNode(session
, userNodePath
);
531 node
= Jcr
.getNode(session
, nodePath
);
536 private SuiteUi
getRelatedUi(Event event
) {
537 return managedUis
.get(get(event
, CMS_VIEW_UID_PROPERTY
));
540 public static String
get(Event event
, String key
) {
541 Object value
= event
.getProperty(key
);
544 // throw new IllegalArgumentException("Property " + key + " must be set");
545 return value
.toString();
550 * Dependency injection.
553 public void addUiProvider(CmsUiProvider uiProvider
, Map
<String
, Object
> properties
) {
554 if (properties
.containsKey(Constants
.SERVICE_PID
)) {
555 String pid
= (String
) properties
.get(Constants
.SERVICE_PID
);
556 RankedObject
.putIfHigherRank(uiProvidersByPid
, pid
, uiProvider
, properties
);
558 if (properties
.containsKey(EntityConstants
.TYPE
)) {
559 List
<String
> types
= LangUtils
.toStringList(properties
.get(EntityConstants
.TYPE
));
560 for (String type
: types
)
561 RankedObject
.putIfHigherRank(uiProvidersByType
, type
, uiProvider
, properties
);
565 public void removeUiProvider(CmsUiProvider uiProvider
, Map
<String
, Object
> properties
) {
566 if (properties
.containsKey(Constants
.SERVICE_PID
)) {
567 String pid
= (String
) properties
.get(Constants
.SERVICE_PID
);
568 if (uiProvidersByPid
.containsKey(pid
)) {
569 if (uiProvidersByPid
.get(pid
).equals(new RankedObject
<CmsUiProvider
>(uiProvider
, properties
))) {
570 uiProvidersByPid
.remove(pid
);
574 if (properties
.containsKey(EntityConstants
.TYPE
)) {
575 List
<String
> types
= LangUtils
.toStringList(properties
.get(EntityConstants
.TYPE
));
576 for (String type
: types
) {
577 if (uiProvidersByType
.containsKey(type
)) {
578 if (uiProvidersByType
.get(type
).equals(new RankedObject
<CmsUiProvider
>(uiProvider
, properties
))) {
579 uiProvidersByType
.remove(type
);
586 public void addLayer(SuiteLayer layer
, Map
<String
, Object
> properties
) {
587 if (properties
.containsKey(Constants
.SERVICE_PID
)) {
588 String pid
= (String
) properties
.get(Constants
.SERVICE_PID
);
589 RankedObject
.putIfHigherRank(layersByPid
, pid
, layer
, properties
);
591 if (properties
.containsKey(EntityConstants
.TYPE
)) {
592 List
<String
> types
= LangUtils
.toStringList(properties
.get(EntityConstants
.TYPE
));
593 for (String type
: types
)
594 RankedObject
.putIfHigherRank(layersByType
, type
, layer
, properties
);
598 public void removeLayer(SuiteLayer layer
, Map
<String
, Object
> properties
) {
599 if (properties
.containsKey(Constants
.SERVICE_PID
)) {
600 String pid
= (String
) properties
.get(Constants
.SERVICE_PID
);
601 if (layersByPid
.containsKey(pid
)) {
602 if (layersByPid
.get(pid
).equals(new RankedObject
<SuiteLayer
>(layer
, properties
))) {
603 layersByPid
.remove(pid
);
607 if (properties
.containsKey(EntityConstants
.TYPE
)) {
608 List
<String
> types
= LangUtils
.toStringList(properties
.get(EntityConstants
.TYPE
));
609 for (String type
: types
) {
610 if (layersByType
.containsKey(type
)) {
611 if (layersByType
.get(type
).equals(new RankedObject
<CmsUiProvider
>(layer
, properties
))) {
612 layersByType
.remove(type
);
619 public void setCmsUserManager(CmsUserManager cmsUserManager
) {
620 this.cmsUserManager
= cmsUserManager
;