org.graylog2.rest.resources.messages.MessageResource Maven / Gradle / Ivy

/**
 * This file is part of Graylog2.
 *
 * Graylog2 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Graylog2 is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Graylog2.  If not, see .
 */
package org.graylog2.rest.resources.messages;

import com.codahale.metrics.annotation.Timed;
import com.google.common.collect.Maps;
import org.apache.shiro.authz.annotation.RequiresAuthentication;
import org.apache.shiro.authz.annotation.RequiresPermissions;
import org.elasticsearch.indices.IndexMissingException;
import org.graylog2.indexer.messages.DocumentNotFoundException;
import org.graylog2.indexer.messages.Messages;
import org.graylog2.indexer.results.ResultMessage;
import org.graylog2.plugin.Message;
import com.wordnik.swagger.annotations.*;
import org.graylog2.rest.resources.RestResource;
import org.graylog2.security.RestPermissions;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.inject.Inject;
import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;
import java.util.List;
import java.util.Map;

/**
 * @author Lennart Koopmann 
 */
@RequiresAuthentication
@Api(value = "Messages", description = "Single messages")
@Path("/messages/{index}")
public class MessageResource extends RestResource {
    private static final Logger LOG = LoggerFactory.getLogger(MessageResource.class);

    private Messages messages;

    @Inject
    public MessageResource(Messages messages) {
        this.messages = messages;
    }

    @GET @Path("/{messageId}") @Timed
    @ApiOperation(value = "Get a single message.")
    @Produces(MediaType.APPLICATION_JSON)
    @ApiResponses(value = {
            @ApiResponse(code = 404, message = "Specified index does not exist."),
            @ApiResponse(code = 404, message = "Message does not exist.")
    })
    public String search(
            @ApiParam(name = "index", value = "The index this message is stored in.", required = true) @PathParam("index") String index,
            @ApiParam(name = "messageId", required = true) @PathParam("messageId") String messageId) {
        if (messageId == null || messageId.isEmpty()) {
        	LOG.error("Missing parameters. Returning HTTP 400.");
        	throw new WebApplicationException(400);
        }
        checkPermission(RestPermissions.MESSAGES_READ, messageId);
		try {
            ResultMessage resultMessage = messages.get(messageId, index);
            Message message = new Message(resultMessage.getMessage());
            checkMessageReadPermission(message);

            return json(resultMessage);
		} catch (IndexMissingException e) {
        	LOG.error("Index {} does not exist. Returning HTTP 404.", e.index().name());
        	throw new WebApplicationException(404);
		} catch (DocumentNotFoundException e1) {
        	LOG.error("Message {} does not exist in index {}. Returning HTTP 404.", messageId, index);
        	throw new WebApplicationException(404);
		}
    }

    private void checkMessageReadPermission(Message message) {
        Boolean permitted = false;
        // if user has "admin" prvileges, do not check stream permissions
        if (isPermitted(RestPermissions.STREAMS_READ, "*"))
            return;
        for (String streamId : message.getStreamIds()) {
            if (isPermitted(RestPermissions.STREAMS_READ, streamId)) {
                permitted = true;
                break;
            }
        }
        if (!permitted)
            throw new ForbiddenException("Not authorized to access message " + message.getId());
    }

    @GET @Path("/analyze") @Timed
    @ApiOperation(value = "Analyze a message string",
                  notes = "Returns what tokens/terms a message string (message or full_message) is split to.")
    @Produces(MediaType.APPLICATION_JSON)
    @RequiresPermissions(RestPermissions.MESSAGES_ANALYZE)
    @ApiResponses(value = {
            @ApiResponse(code = 404, message = "Specified index does not exist."),
    })
    public String analyze(
            @ApiParam(name = "index", value = "The index the message containing the string is stored in.", required = true) @PathParam("index") String index,
            @ApiParam(name = "string", value = "The string to analyze.", required = true) @QueryParam("string") String string) {
        if (string == null || string.isEmpty()) {
        	LOG.error("Missing parameters. Returning HTTP 400.");
        	throw new WebApplicationException(400);
        }
        
        List tokens;
        try {
        	tokens = messages.analyze(string, index);
		} catch (IndexMissingException e) {
        	LOG.error("Index does not exist. Returning HTTP 404.");
        	throw new WebApplicationException(404);
		}
        
        Map result = Maps.newHashMap();
        result.put("tokens", tokens);

        return json(result);
    }

}