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