View Javadoc
1   /**
2    * This file Copyright (c) 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.admincentral.findbar.operation;
35  
36  import static info.magnolia.periscope.operation.OperationResult.successfulResult;
37  
38  import info.magnolia.admincentral.ViewportLayout;
39  import info.magnolia.admincentral.findbar.PeriscopeAppDetailCreator;
40  import info.magnolia.admincentral.findbar.PeriscopeAppDetailCreator.AppDetail;
41  import info.magnolia.periscope.operation.Operation;
42  import info.magnolia.periscope.operation.OperationResult;
43  import info.magnolia.periscope.operation.request.InternalNavigationRequest;
44  import info.magnolia.ui.api.ioc.AdmincentralScoped;
45  import info.magnolia.ui.api.location.LocationController;
46  import info.magnolia.ui.contentapp.detail.DetailLocation;
47  import info.magnolia.ui.contentapp.detail.DetailView;
48  
49  import java.util.Optional;
50  
51  import javax.inject.Inject;
52  
53  import org.apache.commons.lang3.StringUtils;
54  
55  /**
56   * Internal navigator to open some path within some workspace (that is, in a corresponding app).
57   */
58  @AdmincentralScoped
59  public class InternalNavigationOperation implements Operation<InternalNavigationRequest> {
60  
61      private final LocationController locationController;
62      private final PeriscopeAppDetailCreator periscopeAppDetailCreator;
63      private final ViewportLayout viewportLayout;
64  
65      @Inject
66      public InternalNavigationOperation(LocationController locationController, PeriscopeAppDetailCreator periscopeAppDetailCreator, ViewportLayout viewportLayout) {
67          this.locationController = locationController;
68          this.periscopeAppDetailCreator = periscopeAppDetailCreator;
69          this.viewportLayout = viewportLayout;
70      }
71  
72      @Override
73      public OperationResult execute(InternalNavigationRequest request) {
74          Optional<AppDetail> appDetailOptional = periscopeAppDetailCreator.createAppDetailForWorkspace(request.getWorkspace());
75  
76          if (!appDetailOptional.isPresent()) {
77              return new OperationResult(false, String.format("App configuration cannot be found for workspace: '%s'.", request.getWorkspace()));
78          }
79  
80          // If we know the appName, we simply delegate to the particular app.
81          if (StringUtils.isNotBlank(request.getAppName())) {
82              DetailLocation location = new DetailLocation(request.getAppName(), appDetailOptional.get().getSubAppName(), DetailView.ViewType.EDIT, request.getPath(), null);
83              locationController.goTo(location);
84              return successfulResult();
85          }
86  
87  
88          AppDetail appDetail = appDetailOptional.get();
89          DetailLocation location = new DetailLocation(appDetail.getAppName(), appDetail.getSubAppName(), DetailView.ViewType.EDIT, request.getPath(), null);
90  
91          // if target location is already "open", simply show app (and hide find bar)
92          if (location.equals(locationController.getWhere())) {
93              viewportLayout.showApp(locationController.getWhere().getAppName());
94              return successfulResult();
95          }
96  
97          // Navigate to any internal app with given location path and workspace/app-name.
98          locationController.goTo(location);
99          return successfulResult();
100     }
101 }