View Javadoc
1   /**
2    * This file Copyright (c) 2012-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.ui.framework.app;
35  
36  import info.magnolia.cms.security.User;
37  import info.magnolia.context.Context;
38  import info.magnolia.ui.api.app.launcherlayout.AppLauncherLayout;
39  import info.magnolia.ui.api.app.launcherlayout.AppLauncherLayoutManager;
40  import info.magnolia.ui.api.location.DefaultLocation;
41  import info.magnolia.ui.api.location.Location;
42  import info.magnolia.ui.api.location.LocationHistoryMapper;
43  
44  /**
45   * LocationHistoryMapper that creates locations for all apps and shell apps.
46   */
47  public class DefaultLocationHistoryMapper implements LocationHistoryMapper {
48  
49      private final User user;
50      private final AppLauncherLayoutManager appLauncherLayoutManager;
51  
52      public DefaultLocationHistoryMapper(final AppLauncherLayoutManager appLauncherLayoutManager, final Context context) {
53          this.appLauncherLayoutManager = appLauncherLayoutManager;
54          this.user = context.getUser();
55      }
56  
57      @Override
58      public Location getLocation(String fragment) {
59  
60          String appType = DefaultLocation.extractAppType(fragment);
61          String appName = DefaultLocation.extractAppName(fragment);
62          String subAppId = DefaultLocation.extractSubAppId(fragment);
63          String parameter = DefaultLocation.extractParameter(fragment);
64  
65          if (!supported(appType, appName, subAppId, parameter)) {
66              return null;
67          }
68  
69          return new DefaultLocation(appType, appName, subAppId, parameter);
70      }
71  
72      @Override
73      public String getFragment(Location location) {
74  
75          if (!supported(location.getAppType(), location.getAppName(), location.getSubAppId(), location.getParameter())) {
76              return null;
77          }
78  
79          return location.toString();
80      }
81  
82      private boolean supported(String appType, String appName, String subAppId, String parameter) {
83  
84          if (appType.equals(Location.LOCATION_TYPE_SHELL_APP) && (appName.equals("applauncher") || appName.equals("pulse") || appName.equals("favorite"))) {
85              return true;
86          }
87  
88          if (!appType.equals(Location.LOCATION_TYPE_APP)) {
89              return false;
90          }
91  
92          AppLauncherLayout appLauncherLayout = appLauncherLayoutManager.getLayoutForUser(user);
93          return appLauncherLayout.containsApp(appName);
94      }
95  }