new feature for #404 add resource tree function (#2323) (38c965dd) · Commits · SUMMER2020 / students / proj-2002251

dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/controller/ResourcesController.java

+131 −21

Original line number	Diff line number	Diff line
		@@ -60,6 +60,50 @@ public class ResourcesController extends BaseController{
		@Autowired
		private UdfFuncService udfFuncService;

		/**
		* create resource
		*
		* @param loginUser login user
		* @param alias alias
		* @param description description
		* @param type type
		* @return create result code
		*/

		/**
		*
		* @param loginUser login user
		* @param type type
		* @param alias alias
		* @param description description
		* @param pid parent id
		* @param currentDir current directory
		* @return
		*/
		@ApiOperation(value = "createDirctory", notes= "CREATE_RESOURCE_NOTES")
		@ApiImplicitParams({
		@ApiImplicitParam(name = "type", value = "RESOURCE_TYPE", required = true, dataType ="ResourceType"),
		@ApiImplicitParam(name = "name", value = "RESOURCE_NAME", required = true, dataType ="String"),
		@ApiImplicitParam(name = "description", value = "RESOURCE_DESC", dataType ="String"),
		@ApiImplicitParam(name = "file", value = "RESOURCE_FILE", required = true, dataType = "MultipartFile")
		})
		@PostMapping(value = "/directory/create")
		public Result createDirectory(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
		@RequestParam(value = "type") ResourceType type,
		@RequestParam(value ="name") String alias,
		@RequestParam(value = "description", required = false) String description,
		@RequestParam(value ="pid") int pid,
		@RequestParam(value ="currentDir") String currentDir) {
		try {
		logger.info("login user {}, create resource, type: {}, resource alias: {}, desc: {}, file: {},{}",
		loginUser.getUserName(),type, alias, description,pid,currentDir);
		return resourceService.createDirectory(loginUser,alias, description,type ,pid,currentDir);
		} catch (Exception e) {
		logger.error(CREATE_RESOURCE_ERROR.getMsg(),e);
		return error(CREATE_RESOURCE_ERROR.getCode(), CREATE_RESOURCE_ERROR.getMsg());
		}
		}

		/**
		* create resource
		*
		@@ -82,11 +126,13 @@ public class ResourcesController extends BaseController{
		@RequestParam(value = "type") ResourceType type,
		@RequestParam(value ="name") String alias,
		@RequestParam(value = "description", required = false) String description,
		@RequestParam("file") MultipartFile file) {
		@RequestParam("file") MultipartFile file,
		@RequestParam(value ="pid") int pid,
		@RequestParam(value ="currentDir") String currentDir) {
		try {
		logger.info("login user {}, create resource, type: {}, resource alias: {}, desc: {}, file: {},{}",
		loginUser.getUserName(),type, alias, description, file.getName(), file.getOriginalFilename());
		return resourceService.createResource(loginUser,alias, description,type ,file);
		return resourceService.createResource(loginUser,alias, description,type ,file,pid,currentDir);
		} catch (Exception e) {
		logger.error(CREATE_RESOURCE_ERROR.getMsg(),e);
		return error(CREATE_RESOURCE_ERROR.getCode(), CREATE_RESOURCE_ERROR.getMsg());
		@@ -166,6 +212,7 @@ public class ResourcesController extends BaseController{
		@ApiOperation(value = "queryResourceListPaging", notes= "QUERY_RESOURCE_LIST_PAGING_NOTES")
		@ApiImplicitParams({
		@ApiImplicitParam(name = "type", value = "RESOURCE_TYPE", required = true, dataType ="ResourceType"),
		@ApiImplicitParam(name = "id", value = "RESOURCE_ID", required = true, dataType ="int"),
		@ApiImplicitParam(name = "searchVal", value = "SEARCH_VAL", dataType ="String"),
		@ApiImplicitParam(name = "pageNo", value = "PAGE_NO", dataType = "Int", example = "1"),
		@ApiImplicitParam(name = "pageSize", value = "PAGE_SIZE", dataType ="Int",example = "20")
		@@ -174,6 +221,7 @@ public class ResourcesController extends BaseController{
		@ResponseStatus(HttpStatus.OK)
		public Result queryResourceListPaging(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
		@RequestParam(value ="type") ResourceType type,
		@RequestParam(value ="id") int id,
		@RequestParam("pageNo") Integer pageNo,
		@RequestParam(value = "searchVal", required = false) String searchVal,
		@RequestParam("pageSize") Integer pageSize
		@@ -187,7 +235,7 @@ public class ResourcesController extends BaseController{
		}

		searchVal = ParameterUtils.handleEscapes(searchVal);
		result = resourceService.queryResourceListPaging(loginUser,type,searchVal,pageNo, pageSize);
		result = resourceService.queryResourceListPaging(loginUser,id,type,searchVal,pageNo, pageSize);
		return returnDataListPaging(result);
		}catch (Exception e){
		logger.error(QUERY_RESOURCES_LIST_PAGING.getMsg(),e);
		@@ -227,32 +275,89 @@ public class ResourcesController extends BaseController{
		* verify resource by alias and type
		*
		* @param loginUser login user
		* @param alias resource name
		* @param fullName resource full name
		* @param type resource type
		* @return true if the resource name not exists, otherwise return false
		*/
		@ApiOperation(value = "verifyResourceName", notes= "VERIFY_RESOURCE_NAME_NOTES")
		@ApiImplicitParams({
		@ApiImplicitParam(name = "type", value = "RESOURCE_TYPE", required = true, dataType ="ResourceType"),
		@ApiImplicitParam(name = "name", value = "RESOURCE_NAME", required = true, dataType ="String")
		@ApiImplicitParam(name = "fullName", value = "RESOURCE_FULL_NAME", required = true, dataType ="String")
		})
		@GetMapping(value = "/verify-name")
		@ResponseStatus(HttpStatus.OK)
		public Result verifyResourceName(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
		@RequestParam(value ="name") String alias,
		@RequestParam(value ="fullName") String fullName,
		@RequestParam(value ="type") ResourceType type
		) {
		try {
		logger.info("login user {}, verfiy resource alias: {},resource type: {}",
		loginUser.getUserName(), alias,type);
		loginUser.getUserName(), fullName,type);

		return resourceService.verifyResourceName(alias,type,loginUser);
		return resourceService.verifyResourceName(fullName,type,loginUser);
		} catch (Exception e) {
		logger.error(VERIFY_RESOURCE_BY_NAME_AND_TYPE_ERROR.getMsg(), e);
		return error(Status.VERIFY_RESOURCE_BY_NAME_AND_TYPE_ERROR.getCode(), Status.VERIFY_RESOURCE_BY_NAME_AND_TYPE_ERROR.getMsg());
		}
		}

		/**
		* query resources jar list
		*
		* @param loginUser login user
		* @param type resource type
		* @return resource list
		*/
		@ApiOperation(value = "queryResourceJarList", notes= "QUERY_RESOURCE_LIST_NOTES")
		@ApiImplicitParams({
		@ApiImplicitParam(name = "type", value = "RESOURCE_TYPE", required = true, dataType ="ResourceType")
		})
		@GetMapping(value="/list/jar")
		@ResponseStatus(HttpStatus.OK)
		public Result queryResourceJarList(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
		@RequestParam(value ="type") ResourceType type
		){
		try{
		logger.info("query resource list, login user:{}, resource type:{}", loginUser.getUserName(), type.toString());
		Map<String, Object> result = resourceService.queryResourceJarList(loginUser, type);
		return returnDataList(result);
		}catch (Exception e){
		logger.error(QUERY_RESOURCES_LIST_ERROR.getMsg(),e);
		return error(Status.QUERY_RESOURCES_LIST_ERROR.getCode(), Status.QUERY_RESOURCES_LIST_ERROR.getMsg());
		}
		}

		/**
		* query resource by full name and type
		*
		* @param loginUser login user
		* @param fullName resource full name
		* @param type resource type
		* @return true if the resource name not exists, otherwise return false
		*/
		@ApiOperation(value = "queryResource", notes= "QUERY_BY_RESOURCE_NAME")
		@ApiImplicitParams({
		@ApiImplicitParam(name = "type", value = "RESOURCE_TYPE", required = true, dataType ="ResourceType"),
		@ApiImplicitParam(name = "fullName", value = "RESOURCE_FULL_NAME", required = true, dataType ="String")
		})
		@GetMapping(value = "/queryResource")
		@ResponseStatus(HttpStatus.OK)
		public Result queryResource(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
		@RequestParam(value ="fullName",required = false) String fullName,
		@RequestParam(value ="id",required = false) Integer id,
		@RequestParam(value ="type") ResourceType type
		) {
		try {
		logger.info("login user {}, query resource by full name: {} or id: {},resource type: {}",
		loginUser.getUserName(), fullName,id,type);

		return resourceService.queryResource(fullName,id,type);
		} catch (Exception e) {
		logger.error(RESOURCE_NOT_EXIST.getMsg(), e);
		return error(Status.RESOURCE_NOT_EXIST.getCode(), Status.RESOURCE_NOT_EXIST.getMsg());
		}
		}

		/**
		* view resource file online
		*
		@@ -310,16 +415,18 @@ public class ResourcesController extends BaseController{
		@RequestParam(value ="fileName")String fileName,
		@RequestParam(value ="suffix")String fileSuffix,
		@RequestParam(value = "description", required = false) String description,
		@RequestParam(value = "content") String content
		@RequestParam(value = "content") String content,
		@RequestParam(value ="pid") int pid,
		@RequestParam(value ="currentDir") String currentDir
		) {
		try{
		logger.info("login user {}, online create resource! fileName : {}, type : {}, suffix : {},desc : {},content : {}",
		loginUser.getUserName(),fileName,type,fileSuffix,description,content);
		loginUser.getUserName(),fileName,type,fileSuffix,description,content,pid,currentDir);
		if(StringUtils.isEmpty(content)){
		logger.error("resource file contents are not allowed to be empty");
		return error(Status.RESOURCE_FILE_IS_EMPTY.getCode(), RESOURCE_FILE_IS_EMPTY.getMsg());
		}
		return resourceService.onlineCreateResource(loginUser,type,fileName,fileSuffix,description,content);
		return resourceService.onlineCreateResource(loginUser,type,fileName,fileSuffix,description,content,pid,currentDir);
		}catch (Exception e){
		logger.error(CREATE_RESOURCE_FILE_ON_LINE_ERROR.getMsg(),e);
		return error(Status.CREATE_RESOURCE_FILE_ON_LINE_ERROR.getCode(), Status.CREATE_RESOURCE_FILE_ON_LINE_ERROR.getMsg());
		@@ -384,6 +491,9 @@ public class ResourcesController extends BaseController{
		.ok()
		.header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + file.getFilename() + "\"")
		.body(file);
		}catch (RuntimeException e){
		logger.error(e.getMessage(),e);
		return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(e.getMessage());
		}catch (Exception e){
		logger.error(DOWNLOAD_RESOURCE_FILE_ERROR.getMsg(),e);
		return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(Status.DOWNLOAD_RESOURCE_FILE_ERROR.getMsg());
		@@ -658,21 +768,21 @@ public class ResourcesController extends BaseController{
		* @param userId user id
		* @return unauthorized result code
		*/
		@ApiOperation(value = "unauthorizedFile", notes= "UNAUTHORIZED_FILE_NOTES")
		@ApiOperation(value = "authorizeResourceTree", notes= "AUTHORIZE_RESOURCE_TREE_NOTES")
		@ApiImplicitParams({
		@ApiImplicitParam(name = "userId", value = "USER_ID", required = true, dataType ="Int", example = "100")
		})
		@GetMapping(value = "/unauth-file")
		@GetMapping(value = "/authorize-resource-tree")
		@ResponseStatus(HttpStatus.CREATED)
		public Result unauthorizedFile(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
		public Result authorizeResourceTree(@ApiIgnore @RequestAttribute(value = Constants.SESSION_USER) User loginUser,
		@RequestParam("userId") Integer userId) {
		try{
		logger.info("resource unauthorized file, user:{}, unauthorized user id:{}", loginUser.getUserName(), userId);
		Map<String, Object> result = resourceService.unauthorizedFile(loginUser, userId);
		logger.info("all resource file, user:{}, user id:{}", loginUser.getUserName(), userId);
		Map<String, Object> result = resourceService.authorizeResourceTree(loginUser, userId);
		return returnDataList(result);
		}catch (Exception e){
		logger.error(UNAUTHORIZED_FILE_RESOURCE_ERROR.getMsg(),e);
		return error(Status.UNAUTHORIZED_FILE_RESOURCE_ERROR.getCode(), Status.UNAUTHORIZED_FILE_RESOURCE_ERROR.getMsg());
		logger.error(AUTHORIZE_RESOURCE_TREE.getMsg(),e);
		return error(Status.AUTHORIZE_RESOURCE_TREE.getCode(), Status.AUTHORIZE_RESOURCE_TREE.getMsg());
		}
		}

dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/dto/resources/Directory.java

0 → 100644

+29 −0

Original line number	Diff line number	Diff line
		package org.apache.dolphinscheduler.api.dto.resources;

		/*
		* 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.
		*/
		/**
		* directory
		*/
		public class Directory extends ResourceComponent{

		@Override
		public boolean isDirctory() {
		return true;
		}

		}

dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/dto/resources/FileLeaf.java

0 → 100644

+24 −0

Original line number	Diff line number	Diff line
		package org.apache.dolphinscheduler.api.dto.resources;

		/*
		* 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.
		*/
		/**
		* file leaf
		*/
		public class FileLeaf extends ResourceComponent{

		}

dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/dto/resources/ResourceComponent.java

0 → 100644

+193 −0

Original line number	Diff line number	Diff line
		package org.apache.dolphinscheduler.api.dto.resources;

		import com.alibaba.fastjson.annotation.JSONField;
		import com.alibaba.fastjson.annotation.JSONType;
		import org.apache.dolphinscheduler.common.enums.ResourceType;

		import java.util.ArrayList;
		import java.util.List;

		/*
		* 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.
		*/
		/**
		* resource component
		*/
		@JSONType(orders={"id","pid","name","fullName","description","isDirctory","children","type"})
		public abstract class ResourceComponent {
		public ResourceComponent() {
		}

		public ResourceComponent(int id, int pid, String name, String fullName, String description, boolean isDirctory) {
		this.id = id;
		this.pid = pid;
		this.name = name;
		this.fullName = fullName;
		this.description = description;
		this.isDirctory = isDirctory;
		int directoryFlag = isDirctory ? 1:0;
		this.idValue = String.format("%s_%s",id,directoryFlag);
		}


		/**
		* id
		*/
		@JSONField(ordinal = 1)
		protected int id;
		/**
		* parent id
		*/
		@JSONField(ordinal = 2)
		protected int pid;
		/**
		* name
		*/
		@JSONField(ordinal = 3)
		protected String name;
		/**
		* current directory
		*/
		protected String currentDir;
		/**
		* full name
		*/
		@JSONField(ordinal = 4)
		protected String fullName;
		/**
		* description
		*/
		@JSONField(ordinal = 5)
		protected String description;
		/**
		* is directory
		*/
		@JSONField(ordinal = 6)
		protected boolean isDirctory;
		/**
		* id value
		*/
		@JSONField(ordinal = 7)
		protected String idValue;
		/**
		* resoruce type
		*/
		@JSONField(ordinal = 8)
		protected ResourceType type;
		/**
		* children
		*/
		@JSONField(ordinal = 8)
		protected List<ResourceComponent> children = new ArrayList<>();

		/**
		* add resource component
		* @param resourceComponent resource component
		*/
		public void add(ResourceComponent resourceComponent){
		children.add(resourceComponent);
		}

		public String getName(){
		return this.name;
		}

		public String getDescription(){
		return this.description;
		}

		public int getId() {
		return id;
		}

		public void setId(int id) {
		this.id = id;
		}

		public int getPid() {
		return pid;
		}

		public void setPid(int pid) {
		this.pid = pid;
		}

		public void setName(String name) {
		this.name = name;
		}

		public String getFullName() {
		return fullName;
		}

		public void setFullName(String fullName) {
		this.fullName = fullName;
		}

		public void setDescription(String description) {
		this.description = description;
		}

		public boolean isDirctory() {
		return isDirctory;
		}

		public void setDirctory(boolean dirctory) {
		isDirctory = dirctory;
		}

		public String getIdValue() {
		return idValue;
		}

		public void setIdValue(int id,boolean isDirctory) {
		int directoryFlag = isDirctory ? 1:0;
		this.idValue = String.format("%s_%s",id,directoryFlag);
		}

		public ResourceType getType() {
		return type;
		}

		public void setType(ResourceType type) {
		this.type = type;
		}

		public List<ResourceComponent> getChildren() {
		return children;
		}

		public void setChildren(List<ResourceComponent> children) {
		this.children = children;
		}

		@Override
		public String toString() {
		return "ResourceComponent{" +
		"id=" + id +
		", pid=" + pid +
		", name='" + name + '\'' +
		", currentDir='" + currentDir + '\'' +
		", fullName='" + fullName + '\'' +
		", description='" + description + '\'' +
		", isDirctory=" + isDirctory +
		", idValue='" + idValue + '\'' +
		", type=" + type +
		", children=" + children +
		'}';
		}

		}

dolphinscheduler-api/src/main/java/org/apache/dolphinscheduler/api/dto/resources/filter/IFilter.java

0 → 100644

+28 −0

Original line number	Diff line number	Diff line
		/*
		* 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.dolphinscheduler.api.dto.resources.filter;

		import org.apache.dolphinscheduler.dao.entity.Resource;

		import java.util.List;

		/**
		* interface filter
		*/
		public interface IFilter {
		List<Resource> filter();
		}