MotdController.java

/*
 * This file is part of ARSnova Backend.
 * Copyright (C) 2012-2017 The ARSnova Team
 *
 * ARSnova Backend 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.
 *
 * ARSnova Backend 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package de.thm.arsnova.controller;

import de.thm.arsnova.entities.Motd;
import de.thm.arsnova.entities.MotdList;
import de.thm.arsnova.services.IMotdService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletResponse;
import java.util.Date;
import java.util.List;

/**
 *
 */
@RestController
@RequestMapping("/motd")
@Api(value = "/motd", description = "the Motd Controller API")
public class MotdController extends AbstractController {

	@Autowired
	private IMotdService motdService;

	@ApiOperation(value = "get messages. if adminview=false, only messages with startdate<clientdate<enddate are returned")
	@RequestMapping(value = "/", method = RequestMethod.GET)
	@ApiResponses(value = {
		@ApiResponse(code = 204, message = HTML_STATUS_204),
		@ApiResponse(code = 501, message = HTML_STATUS_501)
	})
	public List<Motd> getMotd(
		@ApiParam(value = "clientdate", required = false) @RequestParam(value = "clientdate", defaultValue = "") final String clientdate,
		@ApiParam(value = "adminview", required = false) @RequestParam(value = "adminview", defaultValue = "false") final Boolean adminview,
		@ApiParam(value = "audience", required = false) @RequestParam(value = "audience", defaultValue = "all") final String audience,
		@ApiParam(value = "sessionkey", required = false) @RequestParam(value = "sessionkey", defaultValue = "null") final String sessionkey
	) {
		List<Motd> motds;
		Date client = new Date(System.currentTimeMillis());
		if (!clientdate.isEmpty()) {
			client.setTime(Long.parseLong(clientdate));
		}
		if (adminview) {
			if ("null".equals(sessionkey)) {
				motds = motdService.getAdminMotds();
			} else {
				motds = motdService.getAllSessionMotds(sessionkey);
			}
		} else {
			motds = motdService.getCurrentMotds(client, audience, sessionkey);
		}
		return motds;
	}

	@ApiOperation(value = "create a new message of the day", nickname = "createMotd")
	@ApiResponses(value = {
		@ApiResponse(code = 201, message = HTML_STATUS_201),
		@ApiResponse(code = 503, message = HTML_STATUS_503)
	})
	@RequestMapping(value = "/", method = RequestMethod.POST)
	@ResponseStatus(HttpStatus.CREATED)
	public Motd postNewMotd(
			@ApiParam(value = "current motd", required = true) @RequestBody final Motd motd,
			final HttpServletResponse response
			) {
		if (motd != null) {
			Motd newMotd;
			if ("session".equals(motd.getAudience()) && motd.getSessionkey() != null) {
				newMotd = motdService.saveSessionMotd(motd.getSessionkey(), motd);
			} else {
				newMotd = motdService.saveMotd(motd);
			}
			if (newMotd == null) {
				response.setStatus(HttpStatus.SERVICE_UNAVAILABLE.value());
				return null;
			}
			return newMotd;
		} else {
			response.setStatus(HttpStatus.SERVICE_UNAVAILABLE.value());
			return null;
		}
	}

	@ApiOperation(value = "update a message of the day", nickname = "updateMotd")
	@RequestMapping(value = "/{motdkey}", method = RequestMethod.PUT)
	public Motd updateMotd(
			@ApiParam(value = "motdkey from current motd", required = true) @PathVariable final String motdkey,
			@ApiParam(value = "current motd", required = true) @RequestBody final Motd motd
			) {
		if ("session".equals(motd.getAudience()) && motd.getSessionkey() != null) {
			return motdService.updateSessionMotd(motd.getSessionkey(), motd);
		} else {
			return motdService.updateMotd(motd);
		}
	}

	@ApiOperation(value = "deletes a message of the day", nickname = "deleteMotd")
	@RequestMapping(value = "/{motdkey}", method = RequestMethod.DELETE)
	public void deleteMotd(@ApiParam(value = "Motd-key from the message that shall be deleted", required = true) @PathVariable final String motdkey) {
		Motd motd = motdService.getMotd(motdkey);
		if ("session".equals(motd.getAudience())) {
			motdService.deleteSessionMotd(motd.getSessionkey(), motd);
		} else {
			motdService.deleteMotd(motd);
		}
	}

	@ApiOperation(value = "get a list of the motdkeys the current user has confirmed to be read")
	@RequestMapping(value = "/userlist", method = RequestMethod.GET)
	public MotdList getUserMotdList(
			@ApiParam(value = "users name", required = true) @RequestParam(value = "username", defaultValue = "null", required = true) final String username) {
		return motdService.getMotdListForUser(username);
	}

	@ApiOperation(value = "create a list of the motdkeys the current user has confirmed to be read")
	@RequestMapping(value = "/userlist", method = RequestMethod.POST)
	public MotdList postUserMotdList(
			@ApiParam(value = "current motdlist", required = true) @RequestBody final MotdList userMotdList
			) {
		return motdService.saveUserMotdList(userMotdList);
	}

	@ApiOperation(value = "update a list of the motdkeys the current user has confirmed to be read")
	@RequestMapping(value = "/userlist", method = RequestMethod.PUT)
	public MotdList updateUserMotdList(
			@ApiParam(value = "current motdlist", required = true) @RequestBody final MotdList userMotdList
			) {
		return motdService.updateUserMotdList(userMotdList);
	}
}