View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.rest.service.command.v1;
35  
36  import info.magnolia.commands.CommandsManager;
37  import info.magnolia.commands.chain.Command;
38  import info.magnolia.rest.service.command.AbstractCommandEndpoint;
39  import info.magnolia.rest.service.command.definition.CommandEndpointDefinition;
40  
41  import java.util.Map;
42  
43  import javax.inject.Inject;
44  import javax.jcr.RepositoryException;
45  import javax.ws.rs.Consumes;
46  import javax.ws.rs.POST;
47  import javax.ws.rs.Path;
48  import javax.ws.rs.PathParam;
49  import javax.ws.rs.core.MediaType;
50  import javax.ws.rs.core.Response;
51  
52  import org.slf4j.Logger;
53  import org.slf4j.LoggerFactory;
54  
55  import io.swagger.v3.oas.annotations.Operation;
56  import io.swagger.v3.oas.annotations.responses.ApiResponse;
57  import io.swagger.v3.oas.annotations.responses.ApiResponses;
58  
59  
60  /**
61   * REST service for executing commands.
62   *
63   * Executable commands have to be white listed by adding them to the configuration.
64   *
65   * @deprecated since 1.1 use {@link info.magnolia.rest.service.command.v2.CommandEndpoint} instead.
66   */
67  @Path("/commands/v1")
68  @Deprecated
69  public class CommandEndpoint extends AbstractCommandEndpoint<CommandEndpointDefinition> {
70  
71      private final Logger log = LoggerFactory.getLogger(getClass());
72  
73      @Inject
74      public CommandEndpoint(final CommandEndpointDefinition commandEndpointDefinition, final CommandsManager commandsManager) {
75          super(commandEndpointDefinition, commandsManager);
76      }
77  
78      @POST
79      @Path("/{catalogName}/{commandName:(.)*}")
80      @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
81      @Operation(summary = "Executes a command", description = "Executes a command from a specific catalog")
82      @ApiResponses(value = {
83              @ApiResponse(responseCode = "200", description = STATUS_MESSAGE_OK),
84              @ApiResponse(responseCode = "403", description = STATUS_MESSAGE_FORBIDDEN),
85              @ApiResponse(responseCode = "404", description = STATUS_MESSAGE_COMMAND_NOT_FOUND),
86              @ApiResponse(responseCode = "500", description = STATUS_MESSAGE_ERROR_OCCURRED)
87      })
88      public Response executeCommand(
89              @PathParam("catalogName") String catalogName,
90              @PathParam("commandName") String commandName,
91              Map<String, Object> commandMap) throws RepositoryException {
92  
93          boolean commandResult;
94  
95          if (!isCommandExecutableByCurrentUser(catalogName, commandName)) {
96              log.error("Unauthorized access while executing command [{}] from catalog [{}] with commandMap [{}]", commandName, catalogName, commandMap);
97              return Response.status(Response.Status.FORBIDDEN).build();
98          }
99  
100         Command command = commandsManager.getCommand(catalogName, commandName);
101 
102         if (command == null) {
103             return Response.status(Response.Status.NOT_FOUND).build();
104         }
105 
106         try {
107             commandResult = commandsManager.executeCommand(command, commandMap);
108         } catch (Exception e) {
109             log.error("Error executing command [{}] from catalog [{}] with commandMap [{}]", commandName, catalogName, commandMap, e);
110             return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(e.getMessage()).type(MediaType.TEXT_PLAIN_TYPE).build();
111         }
112 
113         return Response.status(Response.Status.OK).entity(!commandResult).type(MediaType.TEXT_PLAIN_TYPE).build();
114     }
115 
116     @POST
117     @Path("/{commandName:(.)*}")
118     @Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
119     @Operation(summary = "Executes a command", description = "Executes a command from the default catalog")
120     @ApiResponses(value = {
121             @ApiResponse(responseCode = "200", description = STATUS_MESSAGE_OK),
122             @ApiResponse(responseCode = "403", description = STATUS_MESSAGE_FORBIDDEN),
123             @ApiResponse(responseCode = "404", description = STATUS_MESSAGE_COMMAND_NOT_FOUND),
124             @ApiResponse(responseCode = "500", description = STATUS_MESSAGE_ERROR_OCCURRED)
125     })
126     public Response executeCommand(@PathParam("commandName") String commandName, Map<String, Object> commandMap) throws RepositoryException {
127         return executeCommand(null, commandName, commandMap);
128     }
129 }