org.apache.linkis.bml.restful.BmlProjectRestful Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.linkis.bml.restful;
import org.apache.linkis.bml.common.BmlProjectNoEditException;
import org.apache.linkis.bml.common.BmlQueryFailException;
import org.apache.linkis.bml.common.BmlServerParaErrorException;
import org.apache.linkis.bml.conf.BmlServerConfiguration;
import org.apache.linkis.bml.entity.DownloadModel;
import org.apache.linkis.bml.entity.ResourceTask;
import org.apache.linkis.bml.service.*;
import org.apache.linkis.bml.util.HttpRequestHelper;
import org.apache.linkis.common.exception.ErrorException;
import org.apache.linkis.server.Message;
import org.apache.linkis.server.utils.ModuleUserUtils;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.beans.factory.annotation.Autowired;
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.RestController;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.*;
import com.fasterxml.jackson.databind.JsonNode;
import com.github.xiaoymin.knife4j.annotations.ApiOperationSupport;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import static org.apache.linkis.bml.errorcode.BmlServerErrorCodeSummary.FAILED_DOWNLOAD_RESOURCE;
@Api(tags = "bml(bigdata material library) project opreation")
@RequestMapping(path = "/bml")
@RestController
public class BmlProjectRestful {
private static final Logger LOGGER = LoggerFactory.getLogger(BmlProjectRestful.class);
private static final String PROJECT_NAME_STR = "projectName";
private static final String EDIT_USERS_STR = "editUsers";
private static final String ACCESS_USERS_STR = "accessUsers";
public static final String DEFAULT_PROXY_USER =
BmlServerConfiguration.BML_DEFAULT_PROXY_USER().getValue();
@Autowired private BmlProjectService bmlProjectService;
@Autowired private TaskService taskService;
@Autowired private VersionService versionService;
@Autowired private ResourceService resourceService;
@Autowired private DownloadService downloadService;
@ApiOperation(value = "createBmlProject", notes = "create Bml project", response = Message.class)
@ApiImplicitParams({
@ApiImplicitParam(name = "projectName", required = true, dataType = "String"),
@ApiImplicitParam(name = "editUsers", required = true, dataType = "String"),
@ApiImplicitParam(name = "accessUsers", required = true, dataType = "String")
})
@ApiOperationSupport(ignoreParameters = {"jsonNode"})
@RequestMapping(path = "createBmlProject", method = RequestMethod.POST)
public Message createBmlProject(HttpServletRequest request, @RequestBody JsonNode jsonNode) {
String projectName = jsonNode.get(PROJECT_NAME_STR).textValue();
String username = ModuleUserUtils.getOperationUser(request, "createBmlProject" + projectName);
LOGGER.info("{} begins to create a project {} in bml", username, projectName);
JsonNode editUserNode = jsonNode.get(EDIT_USERS_STR);
JsonNode accessUserNode = jsonNode.get(ACCESS_USERS_STR);
List accessUsers = new ArrayList<>();
List editUsers = new ArrayList<>();
if (editUserNode.isArray()) {
for (JsonNode node : editUserNode) {
editUsers.add(node.textValue());
}
}
if (accessUserNode.isArray()) {
for (JsonNode node : accessUserNode) {
accessUsers.add(node.textValue());
}
}
bmlProjectService.createBmlProject(projectName, username, editUsers, accessUsers);
return Message.ok("success to create project(创建工程ok)");
}
@ApiOperation(
value = "uploadShareResource",
notes = "upload share resource",
response = Message.class)
@ApiImplicitParams({
@ApiImplicitParam(name = "system", required = false, dataType = "String", value = "system"),
@ApiImplicitParam(name = "resourceHeader", dataType = "String", value = "resource header"),
@ApiImplicitParam(name = "isExpire", dataType = "String", value = "is expire"),
@ApiImplicitParam(name = "expireType", dataType = "String", value = "expire type"),
@ApiImplicitParam(name = "expireTime", dataType = "String", value = "expire time"),
@ApiImplicitParam(name = "maxVersion", dataType = "Integer", value = "max version"),
@ApiImplicitParam(name = "projectName", required = true, dataType = "String"),
@ApiImplicitParam(name = "file", required = true, dataType = "List")
})
@RequestMapping(path = "uploadShareResource", method = RequestMethod.POST)
public Message uploadShareResource(
HttpServletRequest request,
@RequestParam(name = "system", required = false) String system,
@RequestParam(name = "resourceHeader", required = false) String resourceHeader,
@RequestParam(name = "isExpire", required = false) String isExpire,
@RequestParam(name = "expireType", required = false) String expireType,
@RequestParam(name = "expireTime", required = false) String expireTime,
@RequestParam(name = "maxVersion", required = false) Integer maxVersion,
@RequestParam(name = "projectName") String projectName,
@RequestParam(name = "file") List files)
throws ErrorException {
String username = ModuleUserUtils.getOperationUser(request, "uploadShareResource");
Message message;
try {
LOGGER.info(
"User {} starts uploading shared resources and is proxied as a Hadoop user for uploading(用户 {} 开始上传共享资源,会被代理成hadoop用户进行上传)",
username,
username);
if (!bmlProjectService.checkEditPriv(projectName, username)) {
LOGGER.error(
"{} does not have edit permission on project {}. Upload resource failed ({} 对工程 {} 没有编辑权限, 上传资源失败)",
username,
projectName,
username,
projectName);
throw new BmlProjectNoEditException(
username
+ "does not have edit permission on project "
+ projectName
+ ". Upload resource failed"
+ username
+ " 对工程 { "
+ projectName
+ " }没有编辑权限,上传资源失败");
}
Map properties = new HashMap<>();
properties.put("system", system);
properties.put("resourceHeader", resourceHeader);
properties.put("isExpire", isExpire);
properties.put("expireType", expireType);
properties.put("expireTime", expireTime);
properties.put("maxVersion", maxVersion);
String clientIp = HttpRequestHelper.getIp(request);
properties.put("clientIp", clientIp);
ResourceTask resourceTask =
taskService.createUploadTask(files, DEFAULT_PROXY_USER, properties);
bmlProjectService.addProjectResource(resourceTask.getResourceId(), projectName);
message =
Message.ok("The task of submitting and uploading resources was successful(提交上传资源任务成功)");
message.data("resourceId", resourceTask.getResourceId());
message.data("version", resourceTask.getVersion());
message.data("taskId", resourceTask.getId());
LOGGER.info(
"The task of submitting and uploading resources was successful (用户 {} 提交上传资源任务成功), resourceId is {}",
username,
resourceTask.getResourceId());
} catch (final Exception e) {
LOGGER.error("upload resource for user : {} failed, reason:", username, e);
ErrorException exception =
new ErrorException(
50073, "The commit upload resource task failed: (提交上传资源任务失败)" + e.getMessage());
exception.initCause(e);
throw exception;
}
return message;
}
@ApiOperation(
value = "updateShareResource",
notes = "update share resource",
response = Message.class)
@ApiImplicitParams({
@ApiImplicitParam(name = "resourceId", required = true, dataType = "String"),
@ApiImplicitParam(name = "file", required = true, dataType = "MultipartFile", value = "file")
})
@RequestMapping(path = "updateShareResource", method = RequestMethod.POST)
public Message updateShareResource(
HttpServletRequest request,
@RequestParam("resourceId") String resourceId,
@RequestParam("file") MultipartFile file)
throws ErrorException {
String username =
ModuleUserUtils.getOperationUser(request, "updateShareResource:" + resourceId);
if (StringUtils.isEmpty(resourceId) || !resourceService.checkResourceId(resourceId)) {
LOGGER.error("the error resourceId is {} ", resourceId);
throw new BmlServerParaErrorException(
"the resourceId: "
+ resourceId
+ " is Null, illegal, or deleted (resourceId: "
+ resourceId
+ " 为空,非法或者已被删除!)");
}
if (StringUtils.isEmpty(versionService.getNewestVersion(resourceId))) {
LOGGER.error(
"If the material has not been uploaded or has been deleted, please call the upload interface first(resourceId:{} 之前未上传物料,或物料已被删除,请先调用上传接口.)",
resourceId);
throw new BmlServerParaErrorException(
"If the material has not been uploaded or has been deleted, please call the upload interface first (resourceId: "
+ resourceId
+ " 之前未上传物料,或物料已被删除,请先调用上传接口.!)");
}
Message message;
try {
String projectName = bmlProjectService.getProjectNameByResourceId(resourceId);
if (!bmlProjectService.checkEditPriv(projectName, username)) {
LOGGER.error(
"{} does not have edit permission on project {}. Upload resource failed ({} 对工程 {} 没有编辑权限, 上传资源失败)",
username,
projectName,
username,
projectName);
throw new BmlProjectNoEditException(
username
+ "does not have edit permission on project: "
+ projectName
+ ". Upload resource failed ("
+ username
+ " 对工程 { "
+ projectName
+ " }没有编辑权限,上传资源失败");
}
LOGGER.info(
"User {} starts updating resources {}, using proxy user Hadoop (用户 {} 开始更新资源 {},使用代理用户hadoop)",
username,
resourceId,
username,
resourceId);
String clientIp = HttpRequestHelper.getIp(request);
Map properties = new HashMap<>();
properties.put("clientIp", clientIp);
ResourceTask resourceTask = null;
synchronized (resourceId.intern()) {
resourceTask =
taskService.createUpdateTask(resourceId, DEFAULT_PROXY_USER, file, properties);
}
message = Message.ok("The update resource task was submitted successfully(提交更新资源任务成功)");
message
.data("resourceId", resourceId)
.data("version", resourceTask.getVersion())
.data("taskId", resourceTask.getId());
} catch (final ErrorException e) {
LOGGER.error("{} update resource failed, resourceId is {}, reason:", username, resourceId, e);
throw e;
} catch (final Exception e) {
LOGGER.error("{} update resource failed, resourceId is {}, reason:", username, resourceId, e);
ErrorException exception =
new ErrorException(
50073, "The commit upload resource task failed(提交上传资源任务失败):" + e.getMessage());
exception.initCause(e);
throw exception;
}
LOGGER.info(
"User {} ends updating resources {} (用户 {} 结束更新资源 {} )",
username,
resourceId,
username,
resourceId);
return message;
}
@ApiOperation(
value = "downloadShareResource",
notes = "download share resource",
response = Message.class)
@ApiImplicitParams({
@ApiImplicitParam(name = "resourceId", dataType = "String"),
@ApiImplicitParam(name = "version", dataType = "String")
})
@RequestMapping(path = "downloadShareResource", method = RequestMethod.GET)
public void downloadShareResource(
@RequestParam(value = "resourceId", required = false) String resourceId,
@RequestParam(value = "version", required = false) String version,
HttpServletResponse resp,
HttpServletRequest request)
throws IOException, ErrorException {
String user = RestfulUtils.getUserName(request);
Message message = null;
resp.setContentType("application/x-msdownload");
resp.setHeader("Content-Disposition", "attachment");
String ip = HttpRequestHelper.getIp(request);
DownloadModel downloadModel = new DownloadModel(resourceId, version, user, ip);
try {
String projectName = bmlProjectService.getProjectNameByResourceId(resourceId);
if (!bmlProjectService.checkAccessPriv(projectName, user)) {
LOGGER.error(
"{} does not have view privileges on project {}. Download resource failed({} 对工程 {} 没有查看权限, 下载资源失败)",
user,
projectName,
user,
projectName);
throw new BmlProjectNoEditException(
user
+ " does not have view privileges on project "
+ projectName
+ ". Download resource failed"
+ user
+ " 对工程 { "
+ projectName
+ " }没有编辑权限,上传资源失败");
}
LOGGER.info(
"user {} begin to downLoad resource resourceId is {}, version is {} ,ip is {}, 并代理成hadoop ",
user,
resourceId,
version,
ip);
Map properties = new HashMap<>();
boolean downloadResult =
versionService.downloadResource(
DEFAULT_PROXY_USER, resourceId, version, resp.getOutputStream(), properties);
downloadModel.setEndTime(new Date(System.currentTimeMillis()));
downloadModel.setState(0);
if (!downloadResult) {
LOGGER.warn(
"ResourceId :{}, version:{} has a problem when user {} downloads the resource. The copied size is less than 0 (用户 {} 下载资源 resourceId: {}, version:{} 出现问题,复制的size小于0)",
user,
resourceId,
version,
user,
resourceId,
version);
downloadModel.setState(1);
throw new BmlQueryFailException(FAILED_DOWNLOAD_RESOURCE.getErrorDesc());
}
downloadService.addDownloadRecord(downloadModel);
LOGGER.info(
"User {} ends downloading the resource {} (用户 {} 结束下载资源 {}) ",
user,
resourceId,
user,
resourceId);
} catch (IOException e) {
LOGGER.error(
"IO Exception: ResourceId :{}, version:{} (用户 {} 下载资源 resourceId: {}, version:{} 出现IO异常)",
resourceId,
version,
user,
resourceId,
version,
e);
downloadModel.setEndTime(new Date());
downloadModel.setState(1);
downloadService.addDownloadRecord(downloadModel);
throw new ErrorException(
73562,
"Sorry, the background IO error caused you to download the resources failed(抱歉,后台IO错误造成您本次下载资源失败)");
} catch (final Throwable t) {
LOGGER.error(
"ResourceId :{}, version:{} abnormal when user {} downloads resource (用户 {} 下载资源 resourceId: {}, version:{} 出现异常)",
resourceId,
version,
user,
user,
resourceId,
version);
downloadModel.setEndTime(new Date());
downloadModel.setState(1);
downloadService.addDownloadRecord(downloadModel);
throw new ErrorException(
73561,
"Sorry, the background service error caused you to download the resources failed (抱歉，后台服务出错导致您本次下载资源失败)");
} finally {
IOUtils.closeQuietly(resp.getOutputStream());
}
LOGGER.info(
"{} Download resource {} successfully ({} 下载资源 {} 成功)", user, resourceId, user, resourceId);
}
@ApiOperation(value = "getProjectInfo", notes = "get project info", response = Message.class)
@ApiImplicitParams({
@ApiImplicitParam(name = "projectName", dataType = "String", value = "project name")
})
@RequestMapping(path = "getProjectInfo", method = RequestMethod.GET)
public Message getProjectInfo(
HttpServletRequest request,
@RequestParam(value = "projectName", required = false) String projectName) {
return Message.ok("Obtain project information successfully (获取工程信息成功)");
}
@ApiOperation(
value = "attachResourceAndProject",
notes = "attach Resource and project",
response = Message.class)
@ApiImplicitParams({
@ApiImplicitParam(name = "projectName", required = true, dataType = "String"),
@ApiImplicitParam(name = "resourceId", required = true, dataType = "String")
})
@ApiOperationSupport(ignoreParameters = {"jsonNode"})
@RequestMapping(path = "attachResourceAndProject", method = RequestMethod.POST)
public Message attachResourceAndProject(
HttpServletRequest request, @RequestBody JsonNode jsonNode) throws ErrorException {
String username = ModuleUserUtils.getOperationUser(request, "attachResourceAndProject");
String projectName = jsonNode.get(PROJECT_NAME_STR).textValue();
String resourceId = jsonNode.get("resourceId").textValue();
LOGGER.info("begin to attach {} and {}", projectName, username);
bmlProjectService.attach(projectName, resourceId);
return Message.ok("attach resource and project ok");
}
@ApiOperation(
value = "updateProjectUsers",
notes = "update project users info",
response = Message.class)
@ApiImplicitParams({
@ApiImplicitParam(name = "projectName", required = true, dataType = "String"),
@ApiImplicitParam(name = "editUsers", required = true, dataType = "String"),
@ApiImplicitParam(name = "accessUsers", required = true, dataType = "String")
})
@ApiOperationSupport(ignoreParameters = {"jsonNode"})
@RequestMapping(path = "updateProjectUsers", method = RequestMethod.POST)
public Message updateProjectUsers(HttpServletRequest request, @RequestBody JsonNode jsonNode)
throws ErrorException {
String username = ModuleUserUtils.getOperationUser(request, "updateProjectUsers");
String projectName = jsonNode.get("projectName").textValue();
LOGGER.info("{} begins to update project users for {}", username, projectName);
List editUsers = new ArrayList<>();
List accessUsers = new ArrayList<>();
JsonNode editUsersNode = jsonNode.get("editUsers");
if (editUsersNode.isArray()) {
editUsersNode.forEach(node -> editUsers.add(node.textValue()));
}
JsonNode accessUsersNode = jsonNode.get("accessUsers");
if (accessUsersNode.isArray()) {
accessUsersNode.forEach(node -> accessUsers.add(node.textValue()));
}
bmlProjectService.updateProjectUsers(username, projectName, editUsers, accessUsers);
return Message.ok("Updated project related user success(更新工程的相关用户成功)");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy