Update RecordingController.groovy indentation to two spaces instead of four.
This commit is contained in:
Ghazi Triki
parent
7505975bf8
commit
f1a83c4022
@ -2,254 +2,254 @@ package org.bigbluebutton.web.controllers
|
|||||||
|
|
||||||
import grails.web.context.ServletContextHolder
|
import grails.web.context.ServletContextHolder
|
||||||
import groovy.json.JsonBuilder
|
import groovy.json.JsonBuilder
|
||||||
import org.bigbluebutton.api.MeetingService;
|
import org.bigbluebutton.api.MeetingService
|
||||||
import org.bigbluebutton.api.ParamsProcessorUtil;
|
import org.bigbluebutton.api.ParamsProcessorUtil
|
||||||
import org.bigbluebutton.api.util.ResponseBuilder
|
import org.bigbluebutton.api.util.ResponseBuilder
|
||||||
import org.apache.commons.lang.StringUtils;
|
import org.apache.commons.lang.StringUtils
|
||||||
import org.bigbluebutton.api.ApiErrors;
|
import org.bigbluebutton.api.ApiErrors
|
||||||
import org.bigbluebutton.api.ApiParams
|
import org.bigbluebutton.api.ApiParams
|
||||||
import org.apache.commons.lang3.StringUtils
|
import org.apache.commons.lang3.StringUtils
|
||||||
import org.json.JSONArray
|
import org.json.JSONArray
|
||||||
|
|
||||||
|
|
||||||
class RecordingController {
|
class RecordingController {
|
||||||
private static final String CONTROLLER_NAME = 'RecordingController'
|
private static final String CONTROLLER_NAME = 'RecordingController'
|
||||||
protected static final String RESP_CODE_SUCCESS = 'SUCCESS'
|
protected static final String RESP_CODE_SUCCESS = 'SUCCESS'
|
||||||
protected static final String RESP_CODE_FAILED = 'FAILED'
|
protected static final String RESP_CODE_FAILED = 'FAILED'
|
||||||
protected static Boolean REDIRECT_RESPONSE = true
|
protected static Boolean REDIRECT_RESPONSE = true
|
||||||
|
|
||||||
MeetingService meetingService;
|
MeetingService meetingService
|
||||||
ParamsProcessorUtil paramsProcessorUtil
|
ParamsProcessorUtil paramsProcessorUtil
|
||||||
ResponseBuilder responseBuilder = initResponseBuilder()
|
ResponseBuilder responseBuilder = initResponseBuilder()
|
||||||
|
|
||||||
def initResponseBuilder = {
|
def initResponseBuilder = {
|
||||||
String protocol = this.getClass().getResource("").getProtocol();
|
String protocol = this.getClass().getResource("").getProtocol()
|
||||||
if (Objects.equals(protocol, "jar")) {
|
if (Objects.equals(protocol, "jar")) {
|
||||||
// Application running inside a JAR file
|
// Application running inside a JAR file
|
||||||
responseBuilder = new ResponseBuilder(getClass().getClassLoader(), "/WEB-INF/freemarker")
|
responseBuilder = new ResponseBuilder(getClass().getClassLoader(), "/WEB-INF/freemarker")
|
||||||
} else if (Objects.equals(protocol, "file")) {
|
} else if (Objects.equals(protocol, "file")) {
|
||||||
// Application unzipped and running outside a JAR file
|
// Application unzipped and running outside a JAR file
|
||||||
String templateLoc = ServletContextHolder.servletContext.getRealPath("/WEB-INF/freemarker")
|
String templateLoc = ServletContextHolder.servletContext.getRealPath("/WEB-INF/freemarker")
|
||||||
// We should never have a null `templateLoc`
|
// We should never have a null `templateLoc`
|
||||||
responseBuilder = new ResponseBuilder(new File(templateLoc))
|
responseBuilder = new ResponseBuilder(new File(templateLoc))
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/******************************************************
|
||||||
|
* GET RECORDING TEXT TRACKS API
|
||||||
|
******************************************************/
|
||||||
|
def getRecordingTextTracksHandler = {
|
||||||
|
String API_CALL = "getRecordingTextTracks"
|
||||||
|
log.debug CONTROLLER_NAME + "#${API_CALL}"
|
||||||
|
|
||||||
|
// BEGIN - backward compatibility
|
||||||
|
if (StringUtils.isEmpty(params.checksum)) {
|
||||||
|
invalid("checksumError", "You did not pass the checksum security check")
|
||||||
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
/******************************************************
|
if (StringUtils.isEmpty(params.recordID)) {
|
||||||
* GET RECORDING TEXT TRACKS API
|
invalid("missingParamRecordID", "You must specify a recordID.")
|
||||||
******************************************************/
|
return
|
||||||
def getRecordingTextTracksHandler = {
|
|
||||||
String API_CALL = "getRecordingTextTracks"
|
|
||||||
log.debug CONTROLLER_NAME + "#${API_CALL}"
|
|
||||||
|
|
||||||
// BEGIN - backward compatibility
|
|
||||||
if (StringUtils.isEmpty(params.checksum)) {
|
|
||||||
invalid("checksumError", "You did not pass the checksum security check")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if (StringUtils.isEmpty(params.recordID)) {
|
|
||||||
invalid("missingParamRecordID", "You must specify a recordID.");
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!paramsProcessorUtil.isChecksumSame(API_CALL, params.checksum, request.getQueryString())) {
|
|
||||||
invalid("checksumError", "You did not pass the checksum security check")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
// END - backward compatibility
|
|
||||||
|
|
||||||
ApiErrors errors = new ApiErrors()
|
|
||||||
|
|
||||||
// Do we have a checksum? If none, complain.
|
|
||||||
if (StringUtils.isEmpty(params.checksum)) {
|
|
||||||
errors.missingParamError("checksum");
|
|
||||||
}
|
|
||||||
|
|
||||||
// Do we have a recording id? If none, complain.
|
|
||||||
String recordId = params.recordID
|
|
||||||
if (StringUtils.isEmpty(recordId)) {
|
|
||||||
errors.missingParamError(ApiParams.RECORD_ID);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (errors.hasErrors()) {
|
|
||||||
respondWithErrors(errors)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Do we agree on the checksum? If not, complain.
|
|
||||||
if (!paramsProcessorUtil.isChecksumSame(API_CALL, params.checksum, request.getQueryString())) {
|
|
||||||
errors.checksumError()
|
|
||||||
respondWithErrors(errors)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
String recId = StringUtils.strip(params.recordID)
|
|
||||||
|
|
||||||
// Do we agree on the checksum? If not, complain.
|
|
||||||
//if (! paramsProcessorUtil.isChecksumSame(API_CALL, params.checksum, request.getQueryString())) {
|
|
||||||
// respondWithError("checksumError", "You did not pass the checksum security check.")
|
|
||||||
// return
|
|
||||||
//}
|
|
||||||
|
|
||||||
String result = meetingService.getRecordingTextTracks(recId)
|
|
||||||
|
|
||||||
response.addHeader("Cache-Control", "no-cache")
|
|
||||||
withFormat {
|
|
||||||
json {
|
|
||||||
render(text: result, contentType: "application/json")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private void respondWithError(errorKey, errorMessage) {
|
if (!paramsProcessorUtil.isChecksumSame(API_CALL, params.checksum, request.getQueryString())) {
|
||||||
response.addHeader("Cache-Control", "no-cache")
|
invalid("checksumError", "You did not pass the checksum security check")
|
||||||
withFormat {
|
return
|
||||||
json {
|
}
|
||||||
log.debug "Rendering as json"
|
// END - backward compatibility
|
||||||
def builder = new JsonBuilder()
|
|
||||||
builder.response {
|
ApiErrors errors = new ApiErrors()
|
||||||
returncode RESP_CODE_FAILED
|
|
||||||
messageKey errorKey
|
// Do we have a checksum? If none, complain.
|
||||||
message errorMessage
|
if (StringUtils.isEmpty(params.checksum)) {
|
||||||
}
|
errors.missingParamError("checksum")
|
||||||
render(contentType: "application/json", text: builder.toPrettyString())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
def putRecordingTextTrack = {
|
// Do we have a recording id? If none, complain.
|
||||||
String API_CALL = "putRecordingTextTrack"
|
String recordId = params.recordID
|
||||||
log.debug CONTROLLER_NAME + "#${API_CALL}"
|
if (StringUtils.isEmpty(recordId)) {
|
||||||
|
errors.missingParamError(ApiParams.RECORD_ID)
|
||||||
// BEGIN - backward compatibility
|
|
||||||
if (StringUtils.isEmpty(params.checksum)) {
|
|
||||||
respondWithError("paramError", "Missing param checksum.")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if (StringUtils.isEmpty(params.recordID)) {
|
|
||||||
respondWithError("paramError", "Missing param recordID.");
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
String recordId = StringUtils.strip(params.recordID)
|
|
||||||
|
|
||||||
if (StringUtils.isEmpty(params.kind)) {
|
|
||||||
respondWithError("paramError", "Missing param kind.");
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
String captionsKind = StringUtils.strip(params.kind)
|
|
||||||
|
|
||||||
if (StringUtils.isEmpty(params.lang)) {
|
|
||||||
respondWithError("paramError", "Missing param lang.");
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
String captionsLang = StringUtils.strip(params.lang)
|
|
||||||
String captionsLabel = captionsLang
|
|
||||||
|
|
||||||
if (!StringUtils.isEmpty(params.label)) {
|
|
||||||
captionsLabel = StringUtils.strip(params.label)
|
|
||||||
}
|
|
||||||
|
|
||||||
def uploadedCaptionsFile = request.getFile('file')
|
|
||||||
if (uploadedCaptionsFile && !uploadedCaptionsFile.empty) {
|
|
||||||
def origFilename = uploadedCaptionsFile.getOriginalFilename()
|
|
||||||
def trackId = recordId + "-" + System.currentTimeMillis()
|
|
||||||
def captionsFilePath = meetingService.getCaptionTrackInboxDir() + File.separatorChar + trackId + "-track.txt"
|
|
||||||
def captionsFile = new File(captionsFilePath)
|
|
||||||
|
|
||||||
uploadedCaptionsFile.transferTo(captionsFile)
|
|
||||||
|
|
||||||
String result = meetingService.putRecordingTextTrack(recordId, captionsKind,
|
|
||||||
captionsLang, captionsFile, captionsLabel, origFilename, trackId)
|
|
||||||
|
|
||||||
response.addHeader("Cache-Control", "no-cache")
|
|
||||||
withFormat {
|
|
||||||
json {
|
|
||||||
render(text: result, contentType: "application/json")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
log.warn "Upload failed. File Empty."
|
|
||||||
response.addHeader("Cache-Control", "no-cache")
|
|
||||||
withFormat {
|
|
||||||
json {
|
|
||||||
def builder = new JsonBuilder()
|
|
||||||
builder.response {
|
|
||||||
returncode RESP_CODE_FAILED
|
|
||||||
messageKey = "empty_uploaded_text_track"
|
|
||||||
message = "Empty uploaded text track."
|
|
||||||
}
|
|
||||||
render(contentType: "application/json", text: builder.toPrettyString())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
//TODO: method added for backward compatibility, it will be removed in next versions after 0.8
|
if (errors.hasErrors()) {
|
||||||
private void invalid(key, msg, redirectResponse = false) {
|
respondWithErrors(errors)
|
||||||
// Note: This xml scheme will be DEPRECATED.
|
return
|
||||||
log.debug CONTROLLER_NAME + "#invalid " + msg
|
|
||||||
if (redirectResponse) {
|
|
||||||
ArrayList<Object> errors = new ArrayList<Object>();
|
|
||||||
Map<String, String> errorMap = new LinkedHashMap<String, String>()
|
|
||||||
errorMap.put("key", key)
|
|
||||||
errorMap.put("message", msg)
|
|
||||||
errors.add(errorMap)
|
|
||||||
|
|
||||||
JSONArray errorsJSONArray = new JSONArray(errors)
|
|
||||||
log.debug "JSON Errors {}", errorsJSONArray.toString()
|
|
||||||
|
|
||||||
respondWithRedirect(errorsJSONArray)
|
|
||||||
} else {
|
|
||||||
response.addHeader("Cache-Control", "no-cache")
|
|
||||||
withFormat {
|
|
||||||
xml {
|
|
||||||
render(text: responseBuilder.buildError(key, msg, RESP_CODE_FAILED), contentType: "text/xml")
|
|
||||||
}
|
|
||||||
json {
|
|
||||||
log.debug "Rendering as json"
|
|
||||||
def builder = new JsonBuilder()
|
|
||||||
builder.response {
|
|
||||||
returncode RESP_CODE_FAILED
|
|
||||||
messageKey key
|
|
||||||
message msg
|
|
||||||
}
|
|
||||||
render(contentType: "application/json", text: builder.toPrettyString())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private void respondWithRedirect(errorsJSONArray) {
|
// Do we agree on the checksum? If not, complain.
|
||||||
String logoutUrl = paramsProcessorUtil.getDefaultLogoutUrl()
|
if (!paramsProcessorUtil.isChecksumSame(API_CALL, params.checksum, request.getQueryString())) {
|
||||||
URI oldUri = URI.create(logoutUrl)
|
errors.checksumError()
|
||||||
|
respondWithErrors(errors)
|
||||||
if (!StringUtils.isEmpty(params.logoutURL)) {
|
return
|
||||||
try {
|
|
||||||
oldUri = URI.create(params.logoutURL)
|
|
||||||
} catch (Exception e) {
|
|
||||||
// Do nothing, the variable oldUri was already initialized
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
String newQuery = oldUri.getQuery();
|
|
||||||
|
|
||||||
if (newQuery == null) {
|
|
||||||
newQuery = "errors="
|
|
||||||
} else {
|
|
||||||
newQuery += "&" + "errors="
|
|
||||||
}
|
|
||||||
newQuery += errorsJSONArray
|
|
||||||
|
|
||||||
URI newUri = new URI(oldUri.getScheme(), oldUri.getAuthority(), oldUri.getPath(), newQuery, oldUri.getFragment())
|
|
||||||
|
|
||||||
log.debug "Constructed logout URL {}", newUri.toString()
|
|
||||||
redirect(url: newUri)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
String recId = StringUtils.strip(params.recordID)
|
||||||
|
|
||||||
|
// Do we agree on the checksum? If not, complain.
|
||||||
|
//if (! paramsProcessorUtil.isChecksumSame(API_CALL, params.checksum, request.getQueryString())) {
|
||||||
|
// respondWithError("checksumError", "You did not pass the checksum security check.")
|
||||||
|
// return
|
||||||
|
//}
|
||||||
|
|
||||||
|
String result = meetingService.getRecordingTextTracks(recId)
|
||||||
|
|
||||||
|
response.addHeader("Cache-Control", "no-cache")
|
||||||
|
withFormat {
|
||||||
|
json {
|
||||||
|
render(text: result, contentType: "application/json")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private void respondWithError(errorKey, errorMessage) {
|
||||||
|
response.addHeader("Cache-Control", "no-cache")
|
||||||
|
withFormat {
|
||||||
|
json {
|
||||||
|
log.debug "Rendering as json"
|
||||||
|
def builder = new JsonBuilder()
|
||||||
|
builder.response {
|
||||||
|
returncode RESP_CODE_FAILED
|
||||||
|
messageKey errorKey
|
||||||
|
message errorMessage
|
||||||
|
}
|
||||||
|
render(contentType: "application/json", text: builder.toPrettyString())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
def putRecordingTextTrack = {
|
||||||
|
String API_CALL = "putRecordingTextTrack"
|
||||||
|
log.debug CONTROLLER_NAME + "#${API_CALL}"
|
||||||
|
|
||||||
|
// BEGIN - backward compatibility
|
||||||
|
if (StringUtils.isEmpty(params.checksum)) {
|
||||||
|
respondWithError("paramError", "Missing param checksum.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if (StringUtils.isEmpty(params.recordID)) {
|
||||||
|
respondWithError("paramError", "Missing param recordID.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
String recordId = StringUtils.strip(params.recordID)
|
||||||
|
|
||||||
|
if (StringUtils.isEmpty(params.kind)) {
|
||||||
|
respondWithError("paramError", "Missing param kind.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
String captionsKind = StringUtils.strip(params.kind)
|
||||||
|
|
||||||
|
if (StringUtils.isEmpty(params.lang)) {
|
||||||
|
respondWithError("paramError", "Missing param lang.")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
String captionsLang = StringUtils.strip(params.lang)
|
||||||
|
String captionsLabel = captionsLang
|
||||||
|
|
||||||
|
if (!StringUtils.isEmpty(params.label)) {
|
||||||
|
captionsLabel = StringUtils.strip(params.label)
|
||||||
|
}
|
||||||
|
|
||||||
|
def uploadedCaptionsFile = request.getFile('file')
|
||||||
|
if (uploadedCaptionsFile && !uploadedCaptionsFile.empty) {
|
||||||
|
def origFilename = uploadedCaptionsFile.getOriginalFilename()
|
||||||
|
def trackId = recordId + "-" + System.currentTimeMillis()
|
||||||
|
def captionsFilePath = meetingService.getCaptionTrackInboxDir() + File.separatorChar + trackId + "-track.txt"
|
||||||
|
def captionsFile = new File(captionsFilePath)
|
||||||
|
|
||||||
|
uploadedCaptionsFile.transferTo(captionsFile)
|
||||||
|
|
||||||
|
String result = meetingService.putRecordingTextTrack(recordId, captionsKind,
|
||||||
|
captionsLang, captionsFile, captionsLabel, origFilename, trackId)
|
||||||
|
|
||||||
|
response.addHeader("Cache-Control", "no-cache")
|
||||||
|
withFormat {
|
||||||
|
json {
|
||||||
|
render(text: result, contentType: "application/json")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
log.warn "Upload failed. File Empty."
|
||||||
|
response.addHeader("Cache-Control", "no-cache")
|
||||||
|
withFormat {
|
||||||
|
json {
|
||||||
|
def builder = new JsonBuilder()
|
||||||
|
builder.response {
|
||||||
|
returncode RESP_CODE_FAILED
|
||||||
|
messageKey = "empty_uploaded_text_track"
|
||||||
|
message = "Empty uploaded text track."
|
||||||
|
}
|
||||||
|
render(contentType: "application/json", text: builder.toPrettyString())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
//TODO: method added for backward compatibility, it will be removed in next versions after 0.8
|
||||||
|
private void invalid(key, msg, redirectResponse = false) {
|
||||||
|
// Note: This xml scheme will be DEPRECATED.
|
||||||
|
log.debug CONTROLLER_NAME + "#invalid " + msg
|
||||||
|
if (redirectResponse) {
|
||||||
|
ArrayList<Object> errors = new ArrayList<Object>()
|
||||||
|
Map<String, String> errorMap = new LinkedHashMap<String, String>()
|
||||||
|
errorMap.put("key", key)
|
||||||
|
errorMap.put("message", msg)
|
||||||
|
errors.add(errorMap)
|
||||||
|
|
||||||
|
JSONArray errorsJSONArray = new JSONArray(errors)
|
||||||
|
log.debug "JSON Errors {}", errorsJSONArray.toString()
|
||||||
|
|
||||||
|
respondWithRedirect(errorsJSONArray)
|
||||||
|
} else {
|
||||||
|
response.addHeader("Cache-Control", "no-cache")
|
||||||
|
withFormat {
|
||||||
|
xml {
|
||||||
|
render(text: responseBuilder.buildError(key, msg, RESP_CODE_FAILED), contentType: "text/xml")
|
||||||
|
}
|
||||||
|
json {
|
||||||
|
log.debug "Rendering as json"
|
||||||
|
def builder = new JsonBuilder()
|
||||||
|
builder.response {
|
||||||
|
returncode RESP_CODE_FAILED
|
||||||
|
messageKey key
|
||||||
|
message msg
|
||||||
|
}
|
||||||
|
render(contentType: "application/json", text: builder.toPrettyString())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private void respondWithRedirect(errorsJSONArray) {
|
||||||
|
String logoutUrl = paramsProcessorUtil.getDefaultLogoutUrl()
|
||||||
|
URI oldUri = URI.create(logoutUrl)
|
||||||
|
|
||||||
|
if (!StringUtils.isEmpty(params.logoutURL)) {
|
||||||
|
try {
|
||||||
|
oldUri = URI.create(params.logoutURL)
|
||||||
|
} catch (Exception e) {
|
||||||
|
// Do nothing, the variable oldUri was already initialized
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
String newQuery = oldUri.getQuery()
|
||||||
|
|
||||||
|
if (newQuery == null) {
|
||||||
|
newQuery = "errors="
|
||||||
|
} else {
|
||||||
|
newQuery += "&" + "errors="
|
||||||
|
}
|
||||||
|
newQuery += errorsJSONArray
|
||||||
|
|
||||||
|
URI newUri = new URI(oldUri.getScheme(), oldUri.getAuthority(), oldUri.getPath(), newQuery, oldUri.getFragment())
|
||||||
|
|
||||||
|
log.debug "Constructed logout URL {}", newUri.toString()
|
||||||
|
redirect(url: newUri)
|
||||||
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
Loading…
Reference in New Issue
Block a user