code
stringlengths
23
201k
docstring
stringlengths
17
96.2k
func_name
stringlengths
0
235
language
stringclasses
1 value
repo
stringlengths
8
72
path
stringlengths
11
317
url
stringlengths
57
377
license
stringclasses
7 values
private boolean handleOauth(final HttpServletRequest req, final HttpServletResponse resp) throws IOException { if (hasParam(req, "nooauth")) { // cheat code to allow XML-based authN while OAuth is in use return false; // Let the old login happen } final Props props = getApplication().getServerProps(); final String oauthProviderUrlPattern = props.getString(OAUTH_PROVIDER_URI_KEY, ""); final String oauthRedirectUrl = props.getString(OAUTH_REDIRECT_URI_KEY, ""); if (oauthProviderUrlPattern.isEmpty() || oauthRedirectUrl.isEmpty()) { // no OAuth provider? return false; // Let the old login happen } // add state & redirect URL params final StringBuffer requestUrl = req.getRequestURL(); final String queryString = req.getQueryString(); if (queryString != null) { requestUrl.append('?').append(queryString); } final String stateEncoded = java.net.URLEncoder.encode(requestUrl.toString(), UTF_8); final String redirectUriEncoded = java.net.URLEncoder.encode(oauthRedirectUrl, UTF_8); final String oauthProviderUrl = oauthProviderUrlPattern .replace("{state}", stateEncoded) // OAuth gives it back to us and we redirect there .replace("{redirect_uri}", redirectUriEncoded); // OAuth calls us back there logger.debug("Redirecting to OAuth provider: " + oauthProviderUrl); resp.sendRedirect(oauthProviderUrl); return true; }
Return true if login can, should and is being handled via OAuth provider, as configured.
handleOauth
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
private void handleOauthCallback(final HttpServletRequest req, final HttpServletResponse resp) throws IOException { // did we get back code, or error & error_description? final StringBuilder errMsg = new StringBuilder(); for (final String p : ERROR_FIELDS) { final String v = req.getParameter(p); if (v != null && !v.isEmpty()) { errMsg.append(p).append(": ").append(v).append('\n'); } } // no error in callback... but does it have code? if (errMsg.length() == 0 && !hasParam(req, "code")) { errMsg.append("No code returned\n"); } if (errMsg.length() != 0) { resp.sendError(HttpServletResponse.SC_UNAUTHORIZED, errMsg.toString()); return; } final Map<String, Object> retval = new HashMap<>(); final String ip = WebUtils.getRealClientIpAddr(req); // rest of the magic: this calls UserManager to validate authZ code and sets session cookie: handleAjaxLoginAction(OAUTH_USERNAME_PLACEHOLDER, req.getParameter("code"), ip, resp, retval); if ("success".equals(retval.get("status"))) { // extract return URL from state param (if any, or use req context) and send real redirect: final String requestUrl = getParam(req, "state", req.getContextPath()); logger.debug("Redirecting back to Azkaban: " + requestUrl); resp.sendRedirect(requestUrl); } else { resp.sendError(HttpServletResponse.SC_UNAUTHORIZED, retval.getOrDefault("error", "").toString()); // UM exception or session error } }
Handle OAuth callback to .../?action=oauth_callback. <p> If OAuth flow was successful, request parameters are expected to include authorization code in <CODE>code</CODE> and, optionally, app-specific info in <CODE>state</CODE>. (That info is interpreted today as the final navigation target URL where the user intended to arrive. In the future it may include nonce to protect from XSRF attack.) Authorization code will be passed to UserManager instance for validation, and, if valid, a session will be created for the user and session id returned in a cookie. User then will be redirected to their intended destination URL. <p> If OAuth flow was unsuccessful, parameters may include fields listed in <CODE>ERROR_FIELDS</CODE>, and in any case will not include <CODE>code</CODE>. 401 UNAUTHORIZED error will be returned with as much descriptive info as we can gather.
handleOauthCallback
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
@Override protected void doPost(final HttpServletRequest req, final HttpServletResponse resp) throws ServletException, IOException { Session session = getSessionFromRequest(req); getWebMetrics().markWebPostCall(); logRequest(req, session); if (isIllegalPostRequest(req)) { writeResponse(resp, "Login error. Must pass username and password in request body"); return; } // Handle Multipart differently from other post messages if (ServletFileUpload.isMultipartContent(req)) { final Map<String, Object> params = this.multipartParser.parseMultipart(req); if (session == null) { // See if the session id is properly set. if (params.containsKey(SESSION_ID_KEY)) { final String sessionId = (String) params.get(SESSION_ID_KEY); session = getSessionFromSessionId(sessionId); if (session != null) { handleMultiformPost(req, resp, params, session); return; } } // if there's no valid session, see if it's a one time session. if (!params.containsKey("username") || !params.containsKey("password")) { writeResponse(resp, "Login error. Need username and password"); return; } final String username = (String) params.get("username"); final String password = (String) params.get("password"); final String ip = WebUtils.getRealClientIpAddr(req); try { session = createSession(username, password, ip, true); } catch (final UserManagerException e) { writeResponse(resp, "Login error: " + e.getMessage()); return; } } handleMultiformPost(req, resp, params, session); } else if (API_LOGIN.equals(req.getParameter("action"))) { final Map<String, Object> obj = new HashMap<>(); handleAjaxLoginAction(req, resp, obj); this.writeJSON(resp, obj); } else if ("oauth_callback".equals(req.getParameter("action"))) { handleOauthCallback(req, resp); } else if (session == null) { if (hasParam(req, "username") && hasParam(req, "password")) { // If it's a post command with curl, we create a temporary session try { session = createSession(req); } catch (final UserManagerException e) { writeResponse(resp, "Login error: " + e.getMessage()); } handlePost(req, resp, session); } else { // There are no valid sessions and temporary logins, no we either pass // back a message or redirect. if (isAjaxCall(req)) { final String response = AbstractAzkabanServlet .createJsonResponse("error", "Invalid Session. Need to re-login", API_LOGIN, null); writeResponse(resp, response); } else { handleLogin(req, resp, "Enter username and password"); } } } else { handlePost(req, resp, session); } }
Handle OAuth callback to .../?action=oauth_callback. <p> If OAuth flow was successful, request parameters are expected to include authorization code in <CODE>code</CODE> and, optionally, app-specific info in <CODE>state</CODE>. (That info is interpreted today as the final navigation target URL where the user intended to arrive. In the future it may include nonce to protect from XSRF attack.) Authorization code will be passed to UserManager instance for validation, and, if valid, a session will be created for the user and session id returned in a cookie. User then will be redirected to their intended destination URL. <p> If OAuth flow was unsuccessful, parameters may include fields listed in <CODE>ERROR_FIELDS</CODE>, and in any case will not include <CODE>code</CODE>. 401 UNAUTHORIZED error will be returned with as much descriptive info as we can gather.
doPost
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
private boolean isIllegalPostRequest(final HttpServletRequest req) { return (req.getQueryString() != null && req.getQueryString().contains("password=")); }
Disallows users from logging in by passing their username and password via the request header where it'd be logged. <p> Example of illegal post request: curl -X POST http://localhost:8081/?action=login\&username=azkaban\&password=azkaban <p> req.getParameterMap() or req.getParameterNames() cannot be used because they draw no distinction between the illegal request above and the following valid request: curl -X POST -d "action=login&username=azkaban&password=azkaban" http://localhost:8081/ <p> "password=" is searched for because it leverages the query syntax to determine that the user is passing the password as a parameter name. There is no other ajax call that has a parameter that includes the string "password" at the end which could throw false positives.
isIllegalPostRequest
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
private Session createSession(final HttpServletRequest req) throws UserManagerException, ServletException { final String username = getParam(req, "username"); final String password = getParam(req, "password"); final String ip = WebUtils.getRealClientIpAddr(req); return createSession(username, password, ip, true); }
Disallows users from logging in by passing their username and password via the request header where it'd be logged. <p> Example of illegal post request: curl -X POST http://localhost:8081/?action=login\&username=azkaban\&password=azkaban <p> req.getParameterMap() or req.getParameterNames() cannot be used because they draw no distinction between the illegal request above and the following valid request: curl -X POST -d "action=login&username=azkaban&password=azkaban" http://localhost:8081/ <p> "password=" is searched for because it leverages the query syntax to determine that the user is passing the password as a parameter name. There is no other ajax call that has a parameter that includes the string "password" at the end which could throw false positives.
createSession
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
private Session createSession(final String username, final String password, final String ip, final boolean isSuccessFinal) throws UserManagerException { try { final UserManager manager = getApplication().getUserManager(); final User user = manager.getUser(username, password); if (isSuccessFinal) { WebUtils.reportLoginEvent(EventType.USER_LOGIN, user.getUserId(), ip); } final String randomUID = UUID.randomUUID().toString(); return new Session(randomUID, user, ip); } catch (final Exception e) { WebUtils.reportLoginEvent(EventType.USER_LOGIN, username, ip, false, e.getMessage()); throw e; } }
Brief note on extra parameter use. @param isSuccessFinal {@code createSession} is a good place to invoke event reporter for all but one use case where the outcome of createSession itself is not final -- the login success is not yet assured. This parameter is to handle that one case. If set to {@code false}, then it is caller's responsibility to report the final outcome of the login event if {@code createSession} was successful.
createSession
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
protected boolean hasPermission(final Project project, final User user, final Permission.Type type) { final UserManager userManager = getApplication().getUserManager(); if (project.hasPermission(user, type)) { return true; } for (final String roleName : user.getRoles()) { final Role role = userManager.getRole(roleName); if (role.getPermission().isPermissionSet(type) || role.getPermission().isPermissionSet(Permission.Type.ADMIN)) { return true; } } return false; }
Brief note on extra parameter use. @param isSuccessFinal {@code createSession} is a good place to invoke event reporter for all but one use case where the outcome of createSession itself is not final -- the login success is not yet assured. This parameter is to handle that one case. If set to {@code false}, then it is caller's responsibility to report the final outcome of the login event if {@code createSession} was successful.
hasPermission
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
protected boolean hasAzkabanAdminPermission(final User user) { final UserManager userManager = getApplication().getUserManager(); return user.getRoles().stream() .anyMatch(role -> userManager.getRole(role).getPermission().isPermissionSet(Permission.Type.ADMIN)); }
Brief note on extra parameter use. @param isSuccessFinal {@code createSession} is a good place to invoke event reporter for all but one use case where the outcome of createSession itself is not final -- the login success is not yet assured. This parameter is to handle that one case. If set to {@code false}, then it is caller's responsibility to report the final outcome of the login event if {@code createSession} was successful.
hasAzkabanAdminPermission
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
protected Project filterProjectByPermission(final Project project, final User user, final Permission.Type type) { return filterProjectByPermission(project, user, type, null); }
Filter Project based on user authorization @param project project @param user user @param type permission allowance @return authorized project itself or null if the project is not authorized
filterProjectByPermission
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
protected Project filterProjectByPermission(final Project project, final User user, final Permission.Type type, final Map<String, Object> ret) { if (project == null) { if (ret != null) { ret.put("error", "Project 'null' not found."); } } else if (!hasPermission(project, user, type)) { if (ret != null) { ret.put("error", "User '" + user.getUserId() + "' doesn't have " + type.name() + " permissions on " + project.getName()); } } else { return project; } return null; }
Filter Project based on user authorization @param project project @param user user @param type permission allowance @param ret return map for holding messages @return authorized project itself or null if the project is not authorized
filterProjectByPermission
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
protected void handleAjaxLoginAction(final HttpServletRequest req, final HttpServletResponse resp, final Map<String, Object> ret) throws ServletException { if (hasParam(req, "username") && hasParam(req, "password")) { final String username = getParam(req, "username"); final String password = getParam(req, "password"); final String ip = WebUtils.getRealClientIpAddr(req); handleAjaxLoginAction(username, password, ip, resp, ret); } else { ret.put("error", "Incorrect Login."); } }
Filter Project based on user authorization @param project project @param user user @param type permission allowance @param ret return map for holding messages @return authorized project itself or null if the project is not authorized
handleAjaxLoginAction
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
private void handleAjaxLoginAction(final String username, final String password, final String ip, final HttpServletResponse resp, final Map<String, Object> ret) { Session session = null; try { session = createSession(username, password, ip, false); } catch (final UserManagerException e) { ret.put("error", "Incorrect Login. " + e.getMessage()); return; } final Cookie cookie = new Cookie(BROWSER_SESSION_ID_KEY, session.getSessionId()); cookie.setPath("/"); resp.addCookie(cookie); final Set<Session> sessionsOfSameIP = getApplication().getSessionCache().findSessionsByIP(session.getIp()); // Check potential DDoS attack by bad hosts. logger.info( "Session id created for user '" + session.getUser().getUserId() + "' and ip " + session .getIp() + ", " + sessionsOfSameIP.size() + " session(s) found from this IP"); final boolean sessionAdded = getApplication().getSessionCache().addSession(session); if (sessionAdded) { ret.put("status", "success"); ret.put(SESSION_ID_KEY, session.getSessionId()); WebUtils.reportLoginEvent(EventType.USER_LOGIN, session.getUser().getUserId(), ip); } else { final String message = "Potential DDoS found, the number of sessions for this user and IP " + "reached allowed limit (" + getApplication().getSessionCache() .getMaxNumberOfSessionsPerIpPerUser().get() + ")."; ret.put("error", message); WebUtils.reportLoginEvent(EventType.USER_LOGIN, session.getUser().getUserId(), ip, false, message); } }
Filter Project based on user authorization @param project project @param user user @param type permission allowance @param ret return map for holding messages @return authorized project itself or null if the project is not authorized
handleAjaxLoginAction
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
protected void writeResponse(final HttpServletResponse resp, final String response) throws IOException { final Writer writer = resp.getWriter(); writer.append(response); writer.flush(); }
Filter Project based on user authorization @param project project @param user user @param type permission allowance @param ret return map for holding messages @return authorized project itself or null if the project is not authorized
writeResponse
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
protected boolean isAjaxCall(final HttpServletRequest req) { final String value = req.getHeader("X-Requested-With"); if (value != null) { logger.info("has X-Requested-With " + value); return value.equals("XMLHttpRequest"); } return false; }
Filter Project based on user authorization @param project project @param user user @param type permission allowance @param ret return map for holding messages @return authorized project itself or null if the project is not authorized
isAjaxCall
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
protected void handleDelete(HttpServletRequest req, HttpServletResponse resp, Session session) throws ServletException, IOException { }
The delete request is handed off to the implementor after the user is logged in.
handleDelete
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
protected void handleMultiformPost(final HttpServletRequest req, final HttpServletResponse resp, final Map<String, Object> multipart, final Session session) throws ServletException, IOException { }
The post request is handed off to the implementor after the user is logged in.
handleMultiformPost
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
protected boolean hasImageManagementPermission(final String imageTypeName, final User user, final Permission.Type type) { // Check image management APIs access permission for other users. final PermissionManager permissionManager = getApplication().getPermissionManager(); /** * Azkaban ADMIN role must have full permission to access image management APIs. Hence, no * further permission check is required. */ if (permissionManager.isAzkabanAdmin(user)) { return true; } return permissionManager.hasPermissionForImageType(imageTypeName, user.getUserId(), type); }
Method to check permission to access image management APIs. @param imageTypeName @param user @param type @return boolean
hasImageManagementPermission
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/LoginAbstractAzkabanServlet.java
Apache-2.0
public void add(final String name, final Object value) { this.context.put(name, value); }
Adds variables to the velocity context.
add
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/Page.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/Page.java
Apache-2.0
private void sanitizeContextContents() { for(Object key: this.context.getKeys()) { Object value = this.context.get((String)key); if(key instanceof String && value instanceof String) { this.context.put((String)key, escapeHtmlExceptLineBreaks((String)value)); } } }
Adds variables to the velocity context.
sanitizeContextContents
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/Page.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/Page.java
Apache-2.0
private static String escapeHtmlExceptLineBreaks(String value) { // Convert line breaks to custom newline marker String converted = value.replaceAll("<br/?>", "!NEWLINE!"); // Escape the converted string String escaped = StringEscapeUtils.escapeHtml(converted); // Convert newlines back to <br> return escaped.replaceAll("!NEWLINE!", "<br>"); }
Adds variables to the velocity context.
escapeHtmlExceptLineBreaks
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/Page.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/Page.java
Apache-2.0
public void setMimeType(final String type) { this.mimeType = type; }
Adds variables to the velocity context.
setMimeType
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/Page.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/Page.java
Apache-2.0
public static void hideUploadButtonWhenNeeded(final Page page, final Session session, final UserManager userManager, final Boolean lockdownUploadProjects) { final User user = session.getUser(); if (lockdownUploadProjects && !UserUtils.hasPermissionforAction(userManager, user, Permission.Type.UPLOADPROJECTS)) { page.add("hideUploadProject", true); } }
Method hides the upload button for regular users from relevant pages when the property "lockdown.upload.projects" is set. The button is displayed for admin users and users with upload permissions.
hideUploadButtonWhenNeeded
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/PageUtils.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/PageUtils.java
Apache-2.0
private void handleDownloadProject(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException, IOException { final User user = session.getUser(); final String projectName = getParam(req, "project"); logger.info(user.getUserId() + " is downloading project: " + projectName); final Project project = this.projectManager.getProject(projectName); if (project == null) { this.setErrorMessageInCookie(resp, "Project " + projectName + " doesn't exist."); resp.sendRedirect(req.getContextPath()); return; } if (!hasPermission(project, user, Type.READ)) { this.setErrorMessageInCookie(resp, "No permission to download project " + projectName + "."); resp.sendRedirect(req.getContextPath()); return; } int version = -1; if (hasParam(req, "version")) { version = getIntParam(req, "version"); } ProjectFileHandler projectFileHandler = null; FileInputStream inStream = null; OutputStream outStream = null; try { projectFileHandler = this.projectManager.getProjectFileHandler(project, version); if (projectFileHandler == null) { this.setErrorMessageInCookie(resp, "Project " + projectName + " with version " + version + " doesn't exist"); resp.sendRedirect(req.getContextPath()); return; } final File projectZipFile = projectFileHandler.getLocalFile(); final String logStr = String.format( "downloading project zip file for project \"%s\" at \"%s\"" + " size: %d type: %s fileName: \"%s\"", projectFileHandler.getFileName(), projectZipFile.getAbsolutePath(), projectZipFile.length(), projectFileHandler.getFileType(), projectFileHandler.getFileName()); logger.info(logStr); // now set up HTTP response for downloading file inStream = new FileInputStream(projectZipFile); resp.setContentType(APPLICATION_ZIP_MIME_TYPE); final String headerKey = "Content-Disposition"; final String headerValue = String.format("attachment; filename=\"%s\"", projectFileHandler.getFileName()); resp.setHeader(headerKey, headerValue); resp.setHeader("version", Integer.toString(projectFileHandler.getVersion())); resp.setHeader("projectId", Integer.toString(projectFileHandler.getProjectId())); outStream = resp.getOutputStream(); final byte[] buffer = new byte[this.downloadBufferSize]; int bytesRead = -1; while ((bytesRead = inStream.read(buffer)) != -1) { outStream.write(buffer, 0, bytesRead); } } catch (final Throwable e) { logger.error( "Encountered error while downloading project zip file for project: " + projectName + " by user: " + user.getUserId(), e); throw new ServletException(e); } finally { IOUtils.closeQuietly(inStream); IOUtils.closeQuietly(outStream); if (projectFileHandler != null) { projectFileHandler.deleteLocalFile(); } } }
Download project zip file from DB and send it back client. <p> This method requires a project name and an optional project version.
handleDownloadProject
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handlePurgeProject(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException, IOException { final User user = session.getUser(); final HashMap<String, Object> ret = new HashMap<>(); boolean isOperationSuccessful = true; try { Project project = null; final String projectParam = getParam(req, "project"); if (StringUtils.isNumeric(projectParam)) { project = this.projectManager.getProject(Integer.parseInt(projectParam)); // get // project // by // Id } else { project = this.projectManager.getProject(projectParam); // get project by // name (name cannot // start // from ints) } // invalid project if (project == null) { ret.put(ERROR_PARAM, "invalid project"); isOperationSuccessful = false; } // project is already deleted if (isOperationSuccessful && this.projectManager.isActiveProject(project.getId())) { ret.put(ERROR_PARAM, "Project " + project.getName() + " should be deleted before purging"); isOperationSuccessful = false; } // only eligible users can purge a project if (isOperationSuccessful && !hasPermission(project, user, Type.ADMIN)) { ret.put(ERROR_PARAM, "Cannot purge. User '" + user.getUserId() + "' is not an ADMIN."); isOperationSuccessful = false; } if (isOperationSuccessful) { this.projectManager.purgeProject(project, user); } } catch (final Exception e) { ret.put(ERROR_PARAM, e.getMessage()); isOperationSuccessful = false; } ret.put("success", isOperationSuccessful); this.writeJSON(resp, ret); }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
handlePurgeProject
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void removeAssociatedSchedules(final Project project, final User user) throws ServletException { // remove regular schedules try { for (final Schedule schedule : this.scheduleManager.getSchedules()) { if (schedule.getProjectId() == project.getId()) { logger.info("removing schedule {} for project {} due to project being removed", schedule.getScheduleId(), project.getName()); this.projectManager.postProjectEvent(project, EventType.SCHEDULE, user.getUserId(), "removing schedule due to project removed " + schedule.getScheduleId()); this.scheduleManager.removeSchedule(schedule); } } } catch (final ScheduleManagerException e) { throw new ServletException(e); } // remove flow trigger schedules try { if (this.enableQuartz) { this.scheduler.unschedule(project); } } catch (final SchedulerException e) { logger.error(""); throw new ServletException(e); } }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
removeAssociatedSchedules
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handleRemoveProject(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException, IOException { final User user = session.getUser(); final String projectName = getParam(req, "project"); final Project project = this.projectManager.getProject(projectName); if (project == null) { this.setErrorMessageInCookie(resp, "Project " + projectName + " doesn't exist."); resp.sendRedirect(req.getContextPath()); return; } if (!hasPermission(project, user, Type.ADMIN)) { this.setErrorMessageInCookie(resp, "Cannot delete. User '" + user.getUserId() + "' is not an ADMIN."); resp.sendRedirect(req.getRequestURI() + "?project=" + projectName); return; } removeAssociatedSchedules(project, user); try { this.projectManager.removeProject(project, user); } catch (final ProjectManagerException e) { this.setErrorMessageInCookie(resp, e.getMessage()); resp.sendRedirect(req.getRequestURI() + "?project=" + projectName); return; } this.setSuccessMessageInCookie(resp, "Project '" + projectName + "' was successfully deleted and associated schedules are removed."); resp.sendRedirect(req.getContextPath()); }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
handleRemoveProject
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxChangeDescription(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req, final User user) throws ServletException { final String description = getParam(req, "description"); project.setDescription(description); try { this.projectManager.updateProjectDescription(project, description, user); } catch (final ProjectManagerException e) { ret.put(ERROR_PARAM, e.getMessage()); } }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxChangeDescription
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxChangeUploadSetting(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req, final User user) { if (req.getParameter(ADHOC_UPLOAD) == null) { ret.put(ERROR_PARAM, "adhocUpload parameter is not set"); return; } try { final boolean enableAdhocProject = HttpRequestUtils.getBooleanParam(req, ADHOC_UPLOAD); if (enableAdhocProject) { project.addFeatureFlags(ENABLE_PROJECT_ADHOC_UPLOAD, true); project.setUploadLock(false); } else { project.addFeatureFlags(ENABLE_PROJECT_ADHOC_UPLOAD, false); if (project.getLastModifiedUser().equals(uploadPrivilegeUser)) { project.setUploadLock(true); } } project.setLastModifiedUser(user.getUserId()); project.setLastModifiedTimestamp(System.currentTimeMillis()); this.projectManager.updateProjectFeatureFlag(project, user); } catch (ServletException | ProjectManagerException e) { ret.put(ERROR_PARAM, e.getMessage()); } }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxChangeUploadSetting
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxGetUploadSettings(final Project project, final HashMap<String, Object> ret) { ret.put("isUploadLocked", project.isUploadLocked()); ret.put("adhocUpload", project.isAdhocUploadEnabled()); }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxGetUploadSettings
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxFetchJobInfo(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req) throws ServletException { final String flowName = getParam(req, "flowName"); final String jobName = getParam(req, "jobName"); final Flow flow = project.getFlow(flowName); if (flow == null) { ret.put(ERROR_PARAM, "Flow " + flowName + " not found in project " + project.getName()); return; } final Node node = flow.getNode(jobName); if (node == null) { ret.put(ERROR_PARAM, "Job " + jobName + " not found in flow " + flowName); return; } Props jobProp; try { jobProp = this.projectManager.getProperties(project, flow, jobName, node.getJobSource()); } catch (final ProjectManagerException e) { ret.put(ERROR_PARAM, "Failed to retrieve job properties!"); return; } if (jobProp == null) { jobProp = new Props(); } Props overrideProp; try { overrideProp = this.projectManager .getJobOverrideProperty(project, flow, jobName, node.getJobSource()); } catch (final ProjectManagerException e) { ret.put(ERROR_PARAM, "Failed to retrieve job override properties!"); return; } ret.put("jobName", node.getId()); ret.put("jobType", jobProp.get("type")); if (overrideProp == null) { overrideProp = new Props(jobProp); } final Map<String, String> generalParams = new HashMap<>(); final Map<String, String> overrideParams = new HashMap<>(); for (final String ps : jobProp.getKeySet()) { generalParams.put(ps, jobProp.getString(ps)); } for (final String ops : overrideProp.getKeySet()) { overrideParams.put(ops, overrideProp.getString(ops)); } ret.put("generalParams", generalParams); ret.put("overrideParams", overrideParams); }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxFetchJobInfo
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxSetJobOverrideProperty(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req, final User user) throws ServletException { final String flowName = getParam(req, "flowName"); final String jobName = getParam(req, "jobName"); final Flow flow = project.getFlow(flowName); if (flow == null) { ret.put(ERROR_PARAM, "Flow " + flowName + " not found in project " + project.getName()); return; } final Node node = flow.getNode(jobName); if (node == null) { ret.put(ERROR_PARAM, "Job " + jobName + " not found in flow " + flowName); return; } final Map<String, String> jobParamGroup = this.getParamGroup(req, "jobOverride"); final Props overrideParams = new Props(null, jobParamGroup); try { this.projectManager .setJobOverrideProperty(project, flow, overrideParams, jobName, node.getJobSource(), user); } catch (final ProjectManagerException e) { ret.put(ERROR_PARAM, "Failed to upload job override property"); } }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxSetJobOverrideProperty
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxFetchProjectFlows(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req) throws ServletException { final ArrayList<Map<String, Object>> flowList = new ArrayList<>(); for (final Flow flow : project.getFlows()) { if (!flow.isEmbeddedFlow()) { final HashMap<String, Object> flowObj = new HashMap<>(); flowObj.put(FLOW_ID_PARAM, flow.getId()); flowList.add(flowObj); } } ret.put("flows", flowList); }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxFetchProjectFlows
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxFetchFlowGraph(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req) throws ServletException { final String flowId = getParam(req, "flow"); fillFlowInfo(project, flowId, ret); }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxFetchFlowGraph
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void fillFlowInfo(final Project project, final String flowId, final HashMap<String, Object> ret) { final Flow flow = project.getFlow(flowId); if (flow == null) { ret.put(ERROR_PARAM, "Flow " + flowId + " not found in project " + project.getName()); return; } final ArrayList<Map<String, Object>> nodeList = new ArrayList<>(); for (final Node node : flow.getNodes()) { final HashMap<String, Object> nodeObj = new HashMap<>(); nodeObj.put("id", node.getId()); nodeObj.put("type", node.getType()); if (node.getCondition() != null) { nodeObj.put("condition", node.getCondition()); } if (node.getEmbeddedFlowId() != null) { nodeObj.put(FLOW_ID_PARAM, node.getEmbeddedFlowId()); fillFlowInfo(project, node.getEmbeddedFlowId(), nodeObj); } nodeList.add(nodeObj); final Set<Edge> inEdges = flow.getInEdges(node.getId()); if (inEdges != null && !inEdges.isEmpty()) { final ArrayList<String> inEdgesList = new ArrayList<>(); for (final Edge edge : inEdges) { inEdgesList.add(edge.getSourceId()); } Collections.sort(inEdgesList); nodeObj.put("in", inEdgesList); } } Collections.sort(nodeList, new Comparator<Map<String, Object>>() { @Override public int compare(final Map<String, Object> o1, final Map<String, Object> o2) { final String id = (String) o1.get("id"); return id.compareTo((String) o2.get("id")); } }); ret.put("flow", flowId); ret.put("nodes", nodeList); }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
fillFlowInfo
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
@Override public int compare(final Map<String, Object> o1, final Map<String, Object> o2) { final String id = (String) o1.get("id"); return id.compareTo((String) o2.get("id")); }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
compare
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxFetchFlowNodeData(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req) throws ServletException { final String flowId = getParam(req, "flow"); final Flow flow = project.getFlow(flowId); final String nodeId = getParam(req, "node"); final Node node = flow.getNode(nodeId); if (node == null) { ret.put(ERROR_PARAM, "Job " + nodeId + " doesn't exist."); return; } ret.put("id", nodeId); ret.put("flow", flowId); ret.put("type", node.getType()); final Props jobProps; try { jobProps = this.projectManager.getProperties(project, flow, nodeId, node.getJobSource()); } catch (final ProjectManagerException e) { ret.put(ERROR_PARAM, "Failed to upload job override property for " + nodeId); return; } if (jobProps == null) { ret.put(ERROR_PARAM, "Properties for " + nodeId + " isn't found."); return; } final Map<String, String> properties = PropsUtils.toStringMap(jobProps, true); ret.put("props", properties); if (node.getType().equals("flow")) { if (node.getEmbeddedFlowId() != null) { fillFlowInfo(project, node.getEmbeddedFlowId(), ret); } } }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxFetchFlowNodeData
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxFetchFlow(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req) throws ServletException { final String flowId = getParam(req, "flow"); final Flow flow = project.getFlow(flowId); final ArrayList<Node> flowNodes = new ArrayList<>(flow.getNodes()); Collections.sort(flowNodes, NODE_LEVEL_COMPARATOR); final ArrayList<Object> nodeList = new ArrayList<>(); for (final Node node : flowNodes) { final HashMap<String, Object> nodeObj = new HashMap<>(); nodeObj.put("id", node.getId()); final ArrayList<String> dependencies = new ArrayList<>(); Collection<Edge> collection = flow.getInEdges(node.getId()); if (collection != null) { for (final Edge edge : collection) { dependencies.add(edge.getSourceId()); } } final ArrayList<String> dependents = new ArrayList<>(); collection = flow.getOutEdges(node.getId()); if (collection != null) { for (final Edge edge : collection) { dependents.add(edge.getTargetId()); } } nodeObj.put("dependencies", dependencies); nodeObj.put("dependents", dependents); nodeObj.put("level", node.getLevel()); nodeList.add(nodeObj); } ret.put(FLOW_ID_PARAM, flowId); ret.put("nodes", nodeList); ret.put(FLOW_IS_LOCKED_PARAM, flow.isLocked()); }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxFetchFlow
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxAddProxyUser(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req, final User user) throws ServletException { final String name = getParam(req, "name"); logger.info("Adding proxy user " + name + " by " + user.getUserId()); if (this.userManager.validateProxyUser(name, user)) { try { this.projectManager.addProjectProxyUser(project, name, user); } catch (final ProjectManagerException e) { ret.put(ERROR_PARAM, e.getMessage()); } } else { ret.put(ERROR_PARAM, "User " + user.getUserId() + " has no permission to add " + name + " as proxy user."); return; } }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxAddProxyUser
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxRemoveProxyUser(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req, final User user) throws ServletException { final String name = getParam(req, "name"); logger.info("Removing proxy user " + name + " by " + user.getUserId()); try { this.projectManager.removeProjectProxyUser(project, name, user); } catch (final ProjectManagerException e) { ret.put(ERROR_PARAM, e.getMessage()); } }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxRemoveProxyUser
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxAddPermission(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req, final User user) throws ServletException { final String name = getParam(req, "name"); final boolean group = Boolean.parseBoolean(getParam(req, "group")); if (group) { if (project.getGroupPermission(name) != null) { ret.put(ERROR_PARAM, "Group permission already exists."); return; } if (!this.userManager.validateGroup(name)) { ret.put(ERROR_PARAM, "Group is invalid."); return; } } else { if (project.getUserPermission(name) != null) { ret.put(ERROR_PARAM, "User permission already exists."); return; } if (!this.userManager.validateUser(name)) { ret.put(ERROR_PARAM, "User is invalid."); return; } } final boolean admin = Boolean.parseBoolean(getParam(req, "permissions[admin]")); final boolean read = Boolean.parseBoolean(getParam(req, "permissions[read]")); final boolean write = Boolean.parseBoolean(getParam(req, "permissions[write]")); final boolean execute = Boolean.parseBoolean(getParam(req, "permissions[execute]")); final boolean schedule = Boolean.parseBoolean(getParam(req, "permissions[schedule]")); final Permission perm = new Permission(); if (admin) { perm.setPermission(Type.ADMIN, true); } else { perm.setPermission(Type.READ, read); perm.setPermission(Type.WRITE, write); perm.setPermission(Type.EXECUTE, execute); perm.setPermission(Type.SCHEDULE, schedule); } try { this.projectManager.updateProjectPermission(project, name, perm, group, user); } catch (final ProjectManagerException e) { ret.put(ERROR_PARAM, e.getMessage()); } }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxAddPermission
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxChangePermissions(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req, final User user) throws ServletException { final boolean admin = Boolean.parseBoolean(getParam(req, "permissions[admin]")); final boolean read = Boolean.parseBoolean(getParam(req, "permissions[read]")); final boolean write = Boolean.parseBoolean(getParam(req, "permissions[write]")); final boolean execute = Boolean.parseBoolean(getParam(req, "permissions[execute]")); final boolean schedule = Boolean.parseBoolean(getParam(req, "permissions[schedule]")); final boolean group = Boolean.parseBoolean(getParam(req, "group")); final String name = getParam(req, "name"); final Permission perm; if (group) { perm = project.getGroupPermission(name); } else { perm = project.getUserPermission(name); } if (perm == null) { ret.put(ERROR_PARAM, "Permissions for " + name + " cannot be found."); return; } if (admin || read || write || execute || schedule) { if (admin) { perm.setPermission(Type.ADMIN, true); perm.setPermission(Type.READ, false); perm.setPermission(Type.WRITE, false); perm.setPermission(Type.EXECUTE, false); perm.setPermission(Type.SCHEDULE, false); } else { perm.setPermission(Type.ADMIN, false); perm.setPermission(Type.READ, read); perm.setPermission(Type.WRITE, write); perm.setPermission(Type.EXECUTE, execute); perm.setPermission(Type.SCHEDULE, schedule); } try { this.projectManager .updateProjectPermission(project, name, perm, group, user); } catch (final ProjectManagerException e) { ret.put(ERROR_PARAM, e.getMessage()); } } else { try { this.projectManager.removeProjectPermission(project, name, group, user); } catch (final ProjectManagerException e) { ret.put(ERROR_PARAM, e.getMessage()); } } }
validate readiness of a project and user permission and use projectManager to purge the project if things looks good
ajaxChangePermissions
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxGetPermissions(final Project project, final HashMap<String, Object> ret) { final ArrayList<HashMap<String, Object>> permissions = new ArrayList<>(); for (final Pair<String, Permission> perm : project.getUserPermissions()) { final HashMap<String, Object> permObj = new HashMap<>(); final String userId = perm.getFirst(); permObj.put("username", userId); permObj.put("permission", perm.getSecond().toStringArray()); permissions.add(permObj); } ret.put("permissions", permissions); }
this only returns user permissions, but not group permissions and proxy users
ajaxGetPermissions
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxGetGroupPermissions(final Project project, final HashMap<String, Object> ret) { final ArrayList<HashMap<String, Object>> permissions = new ArrayList<>(); for (final Pair<String, Permission> perm : project.getGroupPermissions()) { final HashMap<String, Object> permObj = new HashMap<>(); final String userId = perm.getFirst(); permObj.put("username", userId); permObj.put("permission", perm.getSecond().toStringArray()); permissions.add(permObj); } ret.put("permissions", permissions); }
this only returns user permissions, but not group permissions and proxy users
ajaxGetGroupPermissions
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxGetProxyUsers(final Project project, final HashMap<String, Object> ret) { final String[] proxyUsers = project.getProxyUsers().toArray(new String[0]); ret.put("proxyUsers", proxyUsers); }
this only returns user permissions, but not group permissions and proxy users
ajaxGetProxyUsers
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxCheckForWritePermission(final Project project, final User user, final HashMap<String, Object> ret) { ret.put("hasWritePermission", hasPermission(project, user, Type.WRITE)); }
this only returns user permissions, but not group permissions and proxy users
ajaxCheckForWritePermission
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxSetFlowLock(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req) throws ServletException { final String flowName = getParam(req, FLOW_NAME_PARAM); final Flow flow = project.getFlow(flowName); if (flow == null) { ret.put(ERROR_PARAM, "Flow " + flowName + " not found in project " + project.getName()); return; } final boolean isLocked = Boolean.parseBoolean(getParam(req, FLOW_IS_LOCKED_PARAM)); String flowLockErrorMessage = null; try { flowLockErrorMessage = getParam(req, FLOW_LOCK_ERROR_MESSAGE_PARAM); } catch (final Exception e) { logger.info("Unable to get flow lock error message"); } // if there is a change in the locked value, then check to see if the project has a flow trigger // that needs to be paused/resumed. if (isLocked != flow.isLocked()) { try { if (this.projectManager.hasFlowTrigger(project, flow)) { if (isLocked) { if (this.scheduler.pauseFlowTriggerIfPresent(project.getId(), flow.getId())) { logger.info("Flow trigger for flow " + project.getName() + "." + flow.getId() + " is paused"); } else { logger.warn("Flow trigger for flow " + project.getName() + "." + flow.getId() + " doesn't exist"); } } else { if (this.scheduler.resumeFlowTriggerIfPresent(project.getId(), flow.getId())) { logger.info("Flow trigger for flow " + project.getName() + "." + flow.getId() + " is resumed"); } else { logger.warn("Flow trigger for flow " + project.getName() + "." + flow.getId() + " doesn't exist"); } } } } catch (final Exception e) { ret.put(ERROR_PARAM, e); } } flow.setLocked(isLocked); flow.setFlowLockErrorMessage(isLocked ? flowLockErrorMessage : null); ret.put(FLOW_IS_LOCKED_PARAM, flow.isLocked()); ret.put(FLOW_ID_PARAM, flow.getId()); ret.put(FLOW_LOCK_ERROR_MESSAGE_PARAM, flow.getFlowLockErrorMessage()); this.projectManager.updateFlow(project, flow); }
Set if a flow is locked. @param project the project for the flow. @param ret the return value. @param req the http request.
ajaxSetFlowLock
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxIsFlowLocked(final Project project, final HashMap<String, Object> ret, final HttpServletRequest req) throws ServletException { final String flowName = getParam(req, FLOW_NAME_PARAM); final Flow flow = project.getFlow(flowName); if (flow == null) { ret.put(ERROR_PARAM, "Flow " + flowName + " not found in project " + project.getName()); return; } ret.put(FLOW_ID_PARAM, flow.getId()); ret.put(FLOW_IS_LOCKED_PARAM, flow.isLocked()); }
Returns true if the flow is locked, false if it is unlocked. @param project the project containing the flow. @param ret the return value. @param req the http request.
ajaxIsFlowLocked
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handleProjectLogsPage(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException, IOException { final Page page = newPage(req, resp, session, "azkaban/webapp/servlet/velocity/projectlogpage.vm"); final String projectName = getParam(req, "project"); final User user = session.getUser(); PageUtils .hideUploadButtonWhenNeeded(page, session, this.userManager, this.lockdownUploadProjects); Project project = null; try { project = this.projectManager.getProject(projectName); if (project == null) { page.add("errorMsg", "Project " + projectName + " doesn't exist."); } else { if (!hasPermission(project, user, Type.READ)) { throw new AccessControlException("No permission to view project " + projectName + "."); } page.add("projectName", project.getName()); page.add("projectId", project.getId()); //params for projectsidebar addProjectSidebarProperties(page, project); page.add("admins", Utils.flattenToString( project.getUsersWithPermission(Type.ADMIN), ",")); final Permission perm = this.getPermissionObject(project, user, Type.ADMIN); page.add("userpermission", perm); final boolean adminPerm = perm.isPermissionSet(Type.ADMIN); if (adminPerm) { page.add("admin", true); } // Set this so we can display execute buttons only to those who have // access. if (perm.isPermissionSet(Type.EXECUTE) || adminPerm) { page.add("exec", true); } else { page.add("exec", false); } } } catch (final AccessControlException e) { page.add("errorMsg", e.getMessage()); } page.render(); }
Returns true if the flow is locked, false if it is unlocked. @param project the project containing the flow. @param ret the return value. @param req the http request.
handleProjectLogsPage
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handleJobHistoryPage(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException, IOException { final Page page = newPage(req, resp, session, "azkaban/webapp/servlet/velocity/jobhistorypage.vm"); final String jobId = getParam(req, "job"); page.add("jobId", jobId); int pageNum = Math.max(1, getIntParam(req, "page", 1)); page.add("page", pageNum); final int pageSize = Math.max(1, getIntParam(req, "size", 25)); page.add("pageSize", pageSize); page.add("recordCount", 0); page.add("projectId", ""); page.add("projectName", ""); page.add("dataSeries", "[]"); page.add("history", null); final String projectName = getParam(req, "project"); final User user = session.getUser(); final Project project = this.projectManager.getProject(projectName); if (project == null) { page.add("errorMsg", "Project " + projectName + " doesn't exist."); page.render(); return; } if (!hasPermission(project, user, Type.READ)) { page.add("errorMsg", "No permission to view project " + projectName + "."); page.render(); return; } page.add("projectId", project.getId()); page.add("projectName", project.getName()); try { final int numResults = this.executorManagerAdapter.getNumberOfJobExecutions(project, jobId); page.add("recordCount", numResults); final int totalPages = ((numResults - 1) / pageSize) + 1; if (pageNum > totalPages) { pageNum = totalPages; page.add("page", pageNum); } final int elementsToSkip = (pageNum - 1) * pageSize; final List<ExecutableJobInfo> jobInfo = this.executorManagerAdapter.getExecutableJobs(project, jobId, elementsToSkip, pageSize); if (CollectionUtils.isNotEmpty(jobInfo)) { page.add("history", jobInfo); final ArrayList<Object> dataSeries = new ArrayList<>(); for (final ExecutableJobInfo info : jobInfo) { final Map<String, Object> map = info.toObject(); dataSeries.add(map); } page.add("dataSeries", JSONUtils.toJSON(dataSeries)); } } catch (final ExecutorManagerException e) { page.add("errorMsg", e.getMessage()); } page.render(); }
Returns true if the flow is locked, false if it is unlocked. @param project the project containing the flow. @param ret the return value. @param req the http request.
handleJobHistoryPage
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handlePermissionPage(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException, IOException { final Page page = newPage(req, resp, session, "azkaban/webapp/servlet/velocity/permissionspage.vm"); if(!addCSRFTokenToPage(page, session)) { writeJSON(resp, ImmutableMap.of("error", "Unable to load the page.")); return; } final String projectName = getParam(req, "project"); final User user = session.getUser(); PageUtils .hideUploadButtonWhenNeeded(page, session, this.userManager, this.lockdownUploadProjects); Project project = null; try { project = this.projectManager.getProject(projectName); if (project == null) { page.add("errorMsg", "Project " + projectName + " not found."); } else { if (!hasPermission(project, user, Type.READ)) { throw new AccessControlException("No permission to view project " + projectName + "."); } page.add("projectName", project.getName()); addProjectSidebarProperties(page, project); page.add("username", user.getUserId()); page.add("admins", Utils.flattenToString( project.getUsersWithPermission(Type.ADMIN), ",")); final Permission perm = this.getPermissionObject(project, user, Type.ADMIN); page.add("userpermission", perm); if (perm.isPermissionSet(Type.ADMIN)) { page.add("admin", true); } final List<Pair<String, Permission>> userPermission = project.getUserPermissions(); if (userPermission != null && !userPermission.isEmpty()) { page.add("permissions", userPermission); } final List<Pair<String, Permission>> groupPermission = project.getGroupPermissions(); if (groupPermission != null && !groupPermission.isEmpty()) { page.add("groupPermissions", groupPermission); } final Set<String> proxyUsers = project.getProxyUsers(); if (proxyUsers != null && !proxyUsers.isEmpty()) { page.add("proxyUsers", proxyUsers); } if (hasPermission(project, user, Type.ADMIN)) { page.add("isAdmin", true); } } } catch (final AccessControlException e) { page.add("errorMsg", e.getMessage()); } page.render(); }
Returns true if the flow is locked, false if it is unlocked. @param project the project containing the flow. @param ret the return value. @param req the http request.
handlePermissionPage
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void addProjectSidebarProperties(Page page, Project project) { // basic project properties page.add("description", project.getDescription()); page.add("createTimestamp", project.getCreateTimestamp()); page.add("lastModifiedTimestamp", project.getLastModifiedTimestamp()); page.add("lastModifiedUser", project.getLastModifiedUser()); // params for project upload // show if a project has prod identifier page.add("projectUploadLock", uploadPrivilegeUser != null && project.isUploadLocked()); page.add("adhocUpload", project.isAdhocUploadEnabled()); page.add("showUploadLockPanel", uploadPrivilegeUser != null); // only show adhocUpload changeable button when this feature is enabled page.add("showAdhocUploadFeature", uploadPrivilegeUser != null && disableAdhocUploadWhenProjectUploadLocked); // hide upload project button when project prod identifier is set page.add("hideUploadProjectButton", uploadPrivilegeUser != null && disableAdhocUploadWhenProjectUploadLocked && project.isUploadLocked()); }
Project sidebar properties shared by multiple web pages are added here. @param page the page to add properties to @param project the current project to add properties from
addProjectSidebarProperties
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handleJobPage(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException { final Page page = newPage(req, resp, session, "azkaban/webapp/servlet/velocity/jobpage.vm"); final String projectName = getParam(req, "project"); final String flowNodePath = getParam(req, "flow"); final String jobName = getParam(req, "job"); final User user = session.getUser(); try { final Project project = this.projectManager.getProject(projectName); logger.info("JobPage: project " + projectName + " version is " + project.getVersion() + ", reference is " + System.identityHashCode(project)); if (project == null) { page.add("errorMsg", "Project " + projectName + " not found."); page.render(); return; } if (!hasPermission(project, user, Type.READ)) { throw new AccessControlException("No permission to view project " + projectName + "."); } page.add("projectName", project.getName()); page.add("hideJobPropsEdit", uploadPrivilegeUser != null && disableJobPropsOverrideWhenProjectUploadLocked && project.isUploadLocked()); final Flow flow = project.getFlow(flowNodePath); if (flow == null) { page.add("errorMsg", "Flow " + flowNodePath + " not found."); page.render(); return; } final String flowId = flow.getId(); page.add("flowid", flowId); page.add("flowlist", flowId.split(Constants.PATH_DELIMITER, 0)); page.add("pathDelimiter", Constants.PATH_DELIMITER); final Node node = flow.getNode(jobName); if (node == null) { page.add("errorMsg", "Job " + jobName + " not found."); page.render(); return; } page.add("jobid", node.getId()); page.add("jobtype", node.getType()); if (node.getCondition() != null) { page.add("condition", node.getCondition()); } Props jobProp = this.projectManager .getJobOverrideProperty(project, flow, jobName, node.getJobSource()); if (jobProp == null) { jobProp = this.projectManager.getProperties(project, flow, jobName, node.getJobSource()); } final List<Pair<String, String>> jobProperties = new ArrayList<>(); for (final String key : jobProp.getKeySet()) { final String value = jobProp.get(key); jobProperties.add(new Pair<>(key, value)); } page.add("jobProperties", jobProperties); final List<String> dependencies = new ArrayList<>(); final Set<Edge> inEdges = flow.getInEdges(node.getId()); if (inEdges != null) { for (final Edge dependency : inEdges) { dependencies.add(dependency.getSourceId()); } } page.add("dependencies", dependencies); final List<String> dependents = new ArrayList<>(); final Set<Edge> outEdges = flow.getOutEdges(node.getId()); if (outEdges != null) { for (final Edge dependent : outEdges) { dependents.add(dependent.getTargetId()); } } page.add("dependents", dependents); // Resolve inherited properties final List<Pair<String, String>> allParentFlows = flow.getParents(); // List of triplets of NAME and NODE PATH of flows from which properties are // inherited as well as the FILE NAME where they are to be found. final List<Triple<String, String, String>> inheritedProperties = new ArrayList<>(); final String nodePropsSource = node.getPropsSource(); if (nodePropsSource != null) { if (flow.getAzkabanFlowVersion() == Constants.AZKABAN_FLOW_VERSION_2_0) { allParentFlows.stream().forEach(p -> inheritedProperties .add(Triple.of(p.getFirst(), p.getSecond(), nodePropsSource))); } else { inheritedProperties.add(Triple.of(nodePropsSource, flowId, nodePropsSource)); ImmutableFlowProps parent = flow.getFlowProps(nodePropsSource); while (parent.getInheritedSource() != null) { final String inheritedSource = parent.getInheritedSource(); inheritedProperties.add(Triple.of(inheritedSource, flowId, inheritedSource)); parent = flow.getFlowProps(parent.getInheritedSource()); } } } page.add("inheritedProperties", inheritedProperties); } catch (final AccessControlException | ProjectManagerException e) { page.add("errorMsg", e.getMessage()); } page.render(); }
Project sidebar properties shared by multiple web pages are added here. @param page the page to add properties to @param project the current project to add properties from
handleJobPage
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handlePropertyPage(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException { final Page page = newPage(req, resp, session, "azkaban/webapp/servlet/velocity/propertypage.vm"); final String projectName = getParam(req, "project"); // flow and job parameters are mainly used to build the breadcrumb. final String flowNodePath = getParam(req, "flow"); final String jobName = getParam(req, "job"); // The name of the file where properties are located final String propsSource = getParam(req, "prop"); // The properties that should be retrieved: // In Flow 1.0 is the entire .properties file. Flow and proNode parameters have same value // In Flow 2.0 is just the properties of provided node. final String propsNodePath = getParam(req, "propNode"); final User user = session.getUser(); try { final Project project = this.projectManager.getProject(projectName); if (project == null) { page.add("errorMsg", "Project " + projectName + " not found."); logger .info("Display inherited job properties. Project " + projectName + " not found."); page.render(); return; } if (!hasPermission(project, user, Type.READ)) { throw new AccessControlException("No permission to view project " + projectName + "."); } page.add("projectName", project.getName()); final Flow flow = project.getFlow(flowNodePath); if (flow == null) { page.add("errorMsg", "Flow " + flowNodePath + " not found."); logger.info("Display inherited job properties. Flow " + flowNodePath + " not found in Project " + projectName + "."); page.render(); return; } page.add("flowid", flow.getId()); page.add("flowlist", flow.getId().split(Constants.PATH_DELIMITER, 0)); page.add("pathDelimiter", Constants.PATH_DELIMITER); final Node job = flow.getNode(jobName); if (job == null) { page.add("errorMsg", "Job " + jobName + " not found."); logger.info("Display inherited job properties. Job " + jobName + " not found in Flow " + flowNodePath + " and Project " + projectName + "."); page.render(); return; } page.add("jobid", job.getId()); final Flow propsNode = project.getFlow(propsNodePath); if (propsNode == null) { page.add("errorMsg", "Nested Flow " + propsNodePath + " not found in Flow " + flowNodePath + "."); logger.info("Display inherited job properties. Nested Flow " + propsNodePath + " not found in Flow " + flowNodePath + " and Project " + projectName + "."); page.render(); return; } final Props propertiesProps = this.projectManager.getProperties(project, propsNode, null, propsSource); if (propertiesProps == null) { page.add("errorMsg", "Property file " + propsSource + " not found."); logger.info("Display inherited job properties. Property file " + propsSource + " not found in Project " + projectName + " and Flow " + flowNodePath + "."); page.render(); return; } final List<Pair<String, String>> propertiesPair = new ArrayList<>(); for (final String key : propertiesProps.getKeySet()) { final String value = propertiesProps.get(key); propertiesPair.add(new Pair<>(key, value)); } page.add("properties", propertiesPair); String propsSourceLabel = propsSource; if (flow.getAzkabanFlowVersion() == Constants.AZKABAN_FLOW_VERSION_2_0) { propsSourceLabel = propsNodePath; } page.add("propsSourceLabel", propsSourceLabel); page.add("propsSource", propsSource); page.add("propsNodePath", propsNodePath); // Resolve property dependencies final List<String> inheritProps = new ArrayList<>(); ImmutableFlowProps parent = flow.getFlowProps(propsSource); while (parent.getInheritedSource() != null) { inheritProps.add(parent.getInheritedSource()); parent = flow.getFlowProps(parent.getInheritedSource()); } page.add("inheritedproperties", inheritProps); final List<String> dependingProps = new ArrayList<>(); ImmutableFlowProps child = flow.getFlowProps(flow.getNode(jobName).getPropsSource()); while (!child.getSource().equals(propsSource)) { dependingProps.add(child.getSource()); child = flow.getFlowProps(child.getInheritedSource()); } page.add("dependingproperties", dependingProps); } catch (final AccessControlException | ProjectManagerException e) { page.add("errorMsg", e.getMessage()); } page.render(); }
Project sidebar properties shared by multiple web pages are added here. @param page the page to add properties to @param project the current project to add properties from
handlePropertyPage
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handleFlowPage(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException { final Page page = newPage(req, resp, session, "azkaban/webapp/servlet/velocity/flowpage.vm"); final String projectName = getParam(req, "project"); final String flowName = getParam(req, "flow"); final User user = session.getUser(); Project project; Flow flow; try { project = this.projectManager.getProject(projectName); if (project == null) { page.add("errorMsg", "Project " + projectName + " not found."); page.render(); return; } if (!hasPermission(project, user, Type.READ)) { throw new AccessControlException("No permission Project " + projectName + "."); } page.add("projectName", project.getName()); page.add("projectId", project.getId()); flow = project.getFlow(flowName); if (flow == null) { page.add("errorMsg", "Flow " + flowName + " not found."); } else { page.add("flowid", flow.getId()); page.add("flowlist", flow.getId().split(Constants.PATH_DELIMITER, 0)); page.add("pathDelimiter", Constants.PATH_DELIMITER); page.add("isLocked", flow.isLocked()); if (flow.isLocked()) { final Props props = this.projectManager.getProps(); final String flowLockErrorMessage = flow.getFlowLockErrorMessage(); final String lockedFlowMsg = flowLockErrorMessage != null ? flowLockErrorMessage : String.format(props.getString(ConfigurationKeys.AZKABAN_LOCKED_FLOW_ERROR_MESSAGE, Constants.DEFAULT_LOCKED_FLOW_ERROR_MESSAGE), flow.getId(), projectName); page.add("error_message", lockedFlowMsg); } page.add("alerterPlugins", this.alerterPlugins); } } catch (final AccessControlException e) { page.add("errorMsg", e.getMessage()); } page.render(); }
Project sidebar properties shared by multiple web pages are added here. @param page the page to add properties to @param project the current project to add properties from
handleFlowPage
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handleProjectPage(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException { final Page page = newPage(req, resp, session, "azkaban/webapp/servlet/velocity/projectpage.vm"); final String projectName = getParam(req, "project"); final User user = session.getUser(); PageUtils .hideUploadButtonWhenNeeded(page, session, this.userManager, this.lockdownUploadProjects); Project project = null; try { project = this.projectManager.getProject(projectName); if (project == null) { page.add("errorMsg", "Project " + projectName + " not found."); } else { if (!hasPermission(project, user, Type.READ)) { throw new AccessControlException("No permission to view project " + projectName + "."); } page.add("projectName", project.getName()); page.add("projectId", project.getId()); //params for projectsidebar addProjectSidebarProperties(page, project); page.add("admins", Utils.flattenToString( project.getUsersWithPermission(Type.ADMIN), ",")); final Permission perm = this.getPermissionObject(project, user, Type.ADMIN); page.add("userpermission", perm); page.add( "validatorFixPrompt", this.projectManager.getProps().getBoolean( ValidatorConfigs.VALIDATOR_AUTO_FIX_PROMPT_FLAG_PARAM, ValidatorConfigs.DEFAULT_VALIDATOR_AUTO_FIX_PROMPT_FLAG)); page.add( "validatorFixLabel", this.projectManager.getProps().get( ValidatorConfigs.VALIDATOR_AUTO_FIX_PROMPT_LABEL_PARAM)); page.add( "validatorFixLink", this.projectManager.getProps().get( ValidatorConfigs.VALIDATOR_AUTO_FIX_PROMPT_LINK_PARAM)); final boolean adminPerm = perm.isPermissionSet(Type.ADMIN); if (adminPerm) { page.add("admin", true); } // Set this so we can display execute buttons only to those who have // access. if (perm.isPermissionSet(Type.EXECUTE) || adminPerm) { page.add("exec", true); } else { page.add("exec", false); } final List<Flow> flows = project.getFlows().stream().filter(flow -> !flow.isEmbeddedFlow()) .collect(Collectors.toList()); if (!flows.isEmpty()) { Collections.sort(flows, FLOW_ID_COMPARATOR); page.add("flows", flows); } } } catch (final AccessControlException e) { page.add("errorMsg", e.getMessage()); } page.render(); }
Project sidebar properties shared by multiple web pages are added here. @param page the page to add properties to @param project the current project to add properties from
handleProjectPage
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handleCreate(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException { final String projectName = hasParam(req, "name") ? getParam(req, "name") : null; final String projectDescription = hasParam(req, "description") ? getParam(req, "description") : null; logger.info("Create project " + projectName); final User user = session.getUser(); String status = null; String action = null; String message = null; HashMap<String, Object> params = null; if (this.lockdownCreateProjects && !UserUtils.hasPermissionforAction(this.userManager, user, Type.CREATEPROJECTS)) { message = "User " + user.getUserId() + " doesn't have permission to create projects."; logger.info(message); status = ERROR_PARAM; } else { try { this.projectManager.createProject(projectName, projectDescription, user, enableSecurityCertManagement ? SecurityTag.NEW_PROJECT : null); status = "success"; action = "redirect"; final String redirect = "manager?project=" + projectName; params = new HashMap<>(); params.put("path", redirect); } catch (final ProjectManagerException e) { message = e.getMessage(); status = ERROR_PARAM; } } final String response = AbstractAzkabanServlet .createJsonResponse(status, message, action, params); try { final Writer write = resp.getWriter(); write.append(response); write.flush(); } catch (final IOException e) { e.printStackTrace(); } }
Project sidebar properties shared by multiple web pages are added here. @param page the page to add properties to @param project the current project to add properties from
handleCreate
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void registerError(final Map<String, String> ret, final String error, final HttpServletResponse resp, final int returnCode) { ret.put(ERROR_PARAM, error); resp.setStatus(returnCode); }
Project sidebar properties shared by multiple web pages are added here. @param page the page to add properties to @param project the current project to add properties from
registerError
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void ajaxHandleUpload(final HttpServletRequest req, final HttpServletResponse resp, final Map<String, String> ret, final Map<String, Object> multipart, final Session session) throws ServletException, IOException { final User user = session.getUser(); final String projectName = (String) multipart.get("project"); // Fetch the uploader's IP final String uploaderIPAddr = WebUtils.getRealClientIpAddr(req); final Project project = validateUploadAndGetProject(resp, ret, user, projectName); if (project == null) { return; } // fail the upload if the project is UPLOAD locked and the user is not the upload privilege user // and the cluster-wide disableAdhocUpload flag is set if (uploadPrivilegeUser != null && disableAdhocUploadWhenProjectUploadLocked && project.isUploadLocked() && !user.getUserId().equals(uploadPrivilegeUser)) { registerError(ret, "Installation Failed. Project '" + projectName + " has UPLOAD LOCK on. \n" + "Create a new project to use adhoc upload feature, as crt deployed project would be automatically locked.\n" + "If you really need enable adhoc upload on the current project, please contact oncall to remove this lock.", resp, HttpServletResponse.SC_FORBIDDEN); return; } final FileItem item = (FileItem) multipart.get("file"); final String name = item.getName(); final String lowercaseExtension = FilenameUtils.getExtension(name).toLowerCase(); final Boolean hasZipExtension = lowercaseExtension.equals("zip"); final String contentType = item.getContentType(); if (contentType == null || !hasZipExtension || (!contentType.startsWith(APPLICATION_ZIP_MIME_TYPE) && !contentType.startsWith("application/x-zip-compressed") && !contentType.startsWith("application/octet-stream"))) { item.delete(); if (!hasZipExtension) { registerError(ret, "File extension '" + lowercaseExtension + "' unrecognized.", resp, HttpServletResponse.SC_BAD_REQUEST); } else { registerError(ret, "Content type '" + contentType + "' does not match extension '" + lowercaseExtension + "'", resp, HttpServletResponse.SC_BAD_REQUEST); } return; } final String autoFix = (String) multipart.get("fix"); final Props props = new Props(); if (autoFix != null && autoFix.equals("off")) { props.put(ValidatorConfigs.CUSTOM_AUTO_FIX_FLAG_PARAM, "false"); } else { props.put(ValidatorConfigs.CUSTOM_AUTO_FIX_FLAG_PARAM, "true"); } ret.put("projectId", String.valueOf(project.getId())); final File tempDir = Utils.createTempDir(); OutputStream out = null; try { logger.info("Uploading file to web server " + name); final File archiveFile = new File(tempDir, name); out = new BufferedOutputStream(new FileOutputStream(archiveFile)); IOUtils.copy(item.getInputStream(), out); out.close(); // get the locked flows for the project, so that they can be locked again after upload final List<Pair<String, String>> lockedFlows = getLockedFlows(project); // record the existing project flows before upload final List<Flow> existingFlows = project.getFlows(); // validate project zip's dependencies and persist the new project metadata into DB final Map<String, ValidationReport> reports = this.projectManager .uploadProject(project, archiveFile, lowercaseExtension, user, props, uploaderIPAddr); // Post-processing after upload // reschedule data triggers if quartz is enabled if (this.enableQuartz) { this.scheduler.unschedule(existingFlows, projectName); this.scheduler.schedule(project, user.getUserId()); } // reset locks for flows as needed lockFlowsForProject(project, lockedFlows); // remove schedule of renamed/deleted flows removeScheduleOfDeletedFlows(project, this.scheduleManager, (schedule) -> { logger.info("Removed schedule with id {} of renamed/deleted flow: {} from project: {}.", schedule.getScheduleId(), schedule.getFlowName(), schedule.getProjectName()); this.projectManager.postProjectEvent(project, EventType.SCHEDULE, "azkaban", "Schedule " + schedule.toString() + " has been removed due to the flow has been removed or renamed during upload process."); }); // uploader is upload privilege user and the project is not protected by feature flag enable.project.adhoc.upload // mark the project with UPLOAD LOCK if it is not already, and persist in DB if (!project.isAdhocUploadEnabled() && user.getUserId().equals(uploadPrivilegeUser) && !project.isUploadLocked()) { project.setUploadLock(true); this.projectManager.updateProjectSetting(project); logger.info("Project {} is PROD", project.getName()); } else if (uploadPrivilegeUser != null && !user.getUserId().equals(uploadPrivilegeUser)) { // when project security lock feature is turned on (only prod project flows would be allowed to push to prod cluster) // and uploader not the upload privileged user, we want to reset prod lock status to false // so that we remain the same restriction "prod project flows would be allowed to push to prod cluster" // regardless we enable/disable AdhocUploadWhenProjectUploadLocked completely project.setUploadLock(false); this.projectManager.updateProjectSetting(project); logger.info("Project {} is non PROD due to uploader {} is not uploadPrivilegeUser {}", project.getName(), user.getUserId(), uploadPrivilegeUser); } registerErrorsAndWarningsFromValidationReport(resp, ret, reports); // Reload the flow_filter to ensure if this project is added to the file, then the filter is current. if (this.executorManagerAdapter instanceof ContainerizedDispatchManager) { ContainerizedDispatchManager containerizedDispatchManager = (ContainerizedDispatchManager) this.executorManagerAdapter; containerizedDispatchManager.getContainerFlowCriteria().reloadFlowFilter(); } } catch (final Exception e) { logger.error("Installation failed for project {}", projectName, e); String error = e.getMessage(); if (error.length() > 512) { error = error.substring(0, 512) + "<br>Too many errors to display.<br>"; } registerError(ret, "Installation Failed.<br>" + error, resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR); } catch (final Throwable e) { logger.error("Severe Error: unable to upload for project {}", projectName, e); registerError(ret, "Server Encounter an unknown Error. <br>", resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR); // rethrow the error as for now we don't know how to recover from it // usually nonExceptionError is severe one. // TODO: if it is outofmemory error, we should restart the server directly. throw e; } finally { if (out != null) { out.close(); } if (tempDir.exists()) { FileUtils.deleteDirectory(tempDir); } } logger.info("Upload: project " + projectName + " version is " + project.getVersion() + ", reference is " + System.identityHashCode(project)); ret.put("version", String.valueOf(project.getVersion())); }
Project sidebar properties shared by multiple web pages are added here. @param page the page to add properties to @param project the current project to add properties from
ajaxHandleUpload
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private Project validateUploadAndGetProject(final HttpServletResponse resp, final Map<String, String> ret, final User user, final String projectName) { if (projectName == null || projectName.isEmpty()) { registerError(ret, "No project name found.", resp, HttpServletResponse.SC_BAD_REQUEST); return null; } final Project project = this.projectManager.getProject(projectName); if (project == null || !project.isActive()) { final String failureCause = (project == null) ? "doesn't exist." : "was already removed."; registerError(ret, "Installation Failed. Project '" + projectName + " " + failureCause, resp, HttpServletResponse.SC_GONE); return null; } logger.info( "Upload: reference of project " + projectName + " is " + System.identityHashCode(project)); if (this.lockdownUploadProjects && !UserUtils .hasPermissionforAction(this.userManager, user, Type.UPLOADPROJECTS)) { final String message = "Project uploading is locked out. Only admin users and users with special permissions can upload projects. " + "User " + user.getUserId() + " doesn't have permission to upload project."; logger.info(message); registerError(ret, message, resp, HttpServletResponse.SC_FORBIDDEN); return null; } if (!hasPermission(project, user, Type.WRITE)) { registerError(ret, "Installation Failed. User '" + user.getUserId() + "' does not have write access.", resp, HttpServletResponse.SC_BAD_REQUEST); return null; } return project; }
@return project. Null if invalid upload params or not enough permissions to proceed.
validateUploadAndGetProject
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
static void removeScheduleOfDeletedFlows(final Project project, final ScheduleManager scheduleManager, final Consumer<Schedule> onDeletedSchedule) { final Set<String> flowNameList = project.getFlows().stream().map(f -> f.getId()).collect( Collectors.toSet()); for (final Schedule schedule : scheduleManager.getAllSchedules()) { if (schedule.getProjectId() == project.getId() && !flowNameList.contains(schedule.getFlowName())) { scheduleManager.removeSchedule(schedule); onDeletedSchedule.accept(schedule); } } }
Remove schedule of renamed/deleted flows @param project project from which old flows will be unscheduled @param scheduleManager the schedule manager @param onDeletedSchedule a callback function to execute with every deleted schedule
removeScheduleOfDeletedFlows
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void registerErrorsAndWarningsFromValidationReport(final HttpServletResponse resp, final Map<String, String> ret, final Map<String, ValidationReport> reports) { final StringBuffer errorMsgs = new StringBuffer(); final StringBuffer warnMsgs = new StringBuffer(); for (final Entry<String, ValidationReport> reportEntry : reports.entrySet()) { final ValidationReport report = reportEntry.getValue(); for (final String msg : report.getInfoMsgs()) { switch (ValidationReport.getInfoMsgLevel(msg)) { case ERROR: errorMsgs.append(ValidationReport.getInfoMsg(msg) + "<br/>"); break; case WARN: warnMsgs.append(ValidationReport.getInfoMsg(msg) + "<br/>"); break; default: break; } } if (!report.getErrorMsgs().isEmpty()) { errorMsgs.append("Validator " + reportEntry.getKey() + " reports errors:<br><br>"); for (final String msg : report.getErrorMsgs()) { errorMsgs.append(msg + "<br>"); } } if (!report.getWarningMsgs().isEmpty()) { warnMsgs.append("Validator " + reportEntry.getKey() + " reports warnings:<br><br>"); for (final String msg : report.getWarningMsgs()) { warnMsgs.append(msg + "<br>"); } } } if (errorMsgs.length() > 0) { // If putting more than 4000 characters in the cookie, the entire message will somehow // get discarded. registerError(ret, errorMsgs.length() > 4000 ? errorMsgs.substring(0, 4000) : errorMsgs.toString(), resp, HttpServletResponse.SC_INTERNAL_SERVER_ERROR); } if (warnMsgs.length() > 0) { ret.put("warn", warnMsgs.length() > 4000 ? warnMsgs.substring(0, 4000) : warnMsgs.toString()); } }
Remove schedule of renamed/deleted flows @param project project from which old flows will be unscheduled @param scheduleManager the schedule manager @param onDeletedSchedule a callback function to execute with every deleted schedule
registerErrorsAndWarningsFromValidationReport
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private List<Pair<String, String>> getLockedFlows(final Project project) { final List<Flow> flows = project.getFlows(); return flows.stream() .filter(flow -> flow.isLocked()) .map(flow -> new Pair<>(flow.getId(), flow.getFlowLockErrorMessage())) .collect(Collectors.toList()); }
@return the list of locked flows and corresponding error messages for the specified project.
getLockedFlows
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void lockFlowsForProject(final Project project, final List<Pair<String, String>> lockedFlows) { for (final Pair<String, String> idMsgPair : lockedFlows) { final Flow flow = project.getFlow(idMsgPair.getFirst()); if (flow != null) { flow.setLocked(true); flow.setFlowLockErrorMessage(idMsgPair.getSecond()); } } }
Lock the specified flows for the project. @param project the project @param lockedFlows list of IDs of flows to lock and corresponding lock error messages
lockFlowsForProject
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handleUpload(final HttpServletRequest req, final HttpServletResponse resp, final Map<String, Object> multipart, final Session session) throws ServletException, IOException { final HashMap<String, String> ret = new HashMap<>(); final String projectName = (String) multipart.get("project"); ajaxHandleUpload(req, resp, ret, multipart, session); if (ret.containsKey(ERROR_PARAM)) { setErrorMessageInCookie(resp, ret.get(ERROR_PARAM)); } if (ret.containsKey("warn")) { setWarnMessageInCookie(resp, ret.get("warn")); } resp.sendRedirect(req.getRequestURI() + "?project=" + projectName); }
Lock the specified flows for the project. @param project the project @param lockedFlows list of IDs of flows to lock and corresponding lock error messages
handleUpload
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private Permission getPermissionObject(final Project project, final User user, final Permission.Type type) { final Permission perm = project.getCollectivePermission(user); for (final String roleName : user.getRoles()) { final Role role = this.userManager.getRole(roleName); perm.addPermissions(role.getPermission()); } return perm; }
Lock the specified flows for the project. @param project the project @param lockedFlows list of IDs of flows to lock and corresponding lock error messages
getPermissionObject
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handleReloadProjectWhitelist(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws IOException { final HashMap<String, Object> ret = new HashMap<>(); if (hasPermission(session.getUser(), Permission.Type.ADMIN)) { try { if (this.projectManager.loadProjectWhiteList()) { ret.put("success", "Project whitelist re-loaded!"); } else { ret.put(ERROR_PARAM, "azkaban.properties doesn't contain property " + ProjectWhitelist.XML_FILE_PARAM); } } catch (final Exception e) { ret.put(ERROR_PARAM, "Exception occurred while trying to re-load project whitelist: " + e); } } else { ret.put(ERROR_PARAM, "Provided session doesn't have admin privilege."); } this.writeJSON(resp, ret); }
Lock the specified flows for the project. @param project the project @param lockedFlows list of IDs of flows to lock and corresponding lock error messages
handleReloadProjectWhitelist
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
protected boolean hasPermission(final User user, final Permission.Type type) { for (final String roleName : user.getRoles()) { final Role role = this.userManager.getRole(roleName); if (role.getPermission().isPermissionSet(type) || role.getPermission().isPermissionSet(Permission.Type.ADMIN)) { return true; } } return false; }
Lock the specified flows for the project. @param project the project @param lockedFlows list of IDs of flows to lock and corresponding lock error messages
hasPermission
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
@Override public int compare(final Node node1, final Node node2) { return node1.getLevel() - node2.getLevel(); }
Lock the specified flows for the project. @param project the project @param lockedFlows list of IDs of flows to lock and corresponding lock error messages
compare
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
public String getPage() { return this.page; }
Lock the specified flows for the project. @param project the project @param lockedFlows list of IDs of flows to lock and corresponding lock error messages
getPage
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
public int getSize() { return this.size; }
Lock the specified flows for the project. @param project the project @param lockedFlows list of IDs of flows to lock and corresponding lock error messages
getSize
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
public boolean getDisabled() { return this.disabled; }
Lock the specified flows for the project. @param project the project @param lockedFlows list of IDs of flows to lock and corresponding lock error messages
getDisabled
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
public boolean isSelected() { return this.selected; }
Lock the specified flows for the project. @param project the project @param lockedFlows list of IDs of flows to lock and corresponding lock error messages
isSelected
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
public void setSelected(final boolean selected) { this.selected = selected; }
Lock the specified flows for the project. @param project the project @param lockedFlows list of IDs of flows to lock and corresponding lock error messages
setSelected
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
public int getNextPage() { return this.nextPage; }
Lock the specified flows for the project. @param project the project @param lockedFlows list of IDs of flows to lock and corresponding lock error messages
getNextPage
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectManagerServlet.java
Apache-2.0
private void handleAjaxAction(final HttpServletRequest req, final HttpServletResponse resp, final Session session, final ProjectManager manager) throws ServletException, IOException { final String ajaxName = getParam(req, "ajax"); final HashMap<String, Object> ret = new HashMap<>(); if (API_FETCH_ALL_PROJECTS.equals(ajaxName)) { final List<Project> projects = manager.getProjects(); final List<SimplifiedProject> simplifiedProjects = toSimplifiedProjects(projects); ret.put("projects", simplifiedProjects); } else if (API_FETCH_USER_PROJECTS.equals(ajaxName)) { handleFetchUserProjects(req, session, manager, ret); } this.writeJSON(resp, ret); }
ProjectServlet class now handles ajax requests. It returns a @SimplifiedProject object: information regarding projects, and information regarding user and project association
handleAjaxAction
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
private void handleFetchUserProjects(final HttpServletRequest req, final Session session, final ProjectManager manager, final HashMap<String, Object> ret) throws ServletException { User user = null; // if key "user" is specified, follow this logic if (hasParam(req, "user")) { final String userParam = getParam(req, "user"); if (userParam.isEmpty()) { user = session.getUser(); } else { user = new User(userParam); } } else { // if key "user" is not specified, default to the session user user = session.getUser(); } final List<Project> projects = manager.getUserProjects(user); final List<SimplifiedProject> simplifiedProjects = toSimplifiedProjects(projects); ret.put("projects", simplifiedProjects); }
We know the intention of API call is to return project ownership based on given user. <br> If user provides an user name, the method honors it <br> If user provides an empty user name, the user defaults to the session user<br> If user does not provide the user param, the user also defaults to the session user<br>
handleFetchUserProjects
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
private List<SimplifiedProject> toSimplifiedProjects(final List<Project> projects) { final List<SimplifiedProject> simplifiedProjects = new ArrayList<>(); for (final Project p : projects) { final SimplifiedProject sp = new SimplifiedProject(p.getId(), p.getName(), p.getLastModifiedUser(), p.getCreateTimestamp(), p.getUserPermissions(), p.getGroupPermissions()); simplifiedProjects.add(sp); } return simplifiedProjects; }
A simple helper method that converts a List<Project> to List<SimplifiedProject>
toSimplifiedProjects
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
private void handlePageRender(final HttpServletRequest req, final HttpServletResponse resp, final Session session, final ProjectManager manager) { final User user = session.getUser(); final Page page = newPage(req, resp, session, "azkaban/webapp/servlet/velocity/index.vm"); if (this.lockdownCreateProjects && !UserUtils.hasPermissionforAction(this.userManager, user, Permission.Type.CREATEPROJECTS)) { page.add("hideCreateProject", true); } if (hasParam(req, "all")) { final List<Project> projects = manager.getProjects(); page.add("viewProjects", "all"); page.add("projects", projects); } else if (hasParam(req, "group")) { final List<Project> projects = manager.getGroupProjects(user); page.add("viewProjects", "group"); page.add("projects", projects); } else { final List<Project> projects = manager.getUserProjects(user); page.add("viewProjects", "personal"); page.add("projects", projects); } page.render(); }
Renders the user homepage that users see when they log in
handlePageRender
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
private void handleDoAction(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException { if (getParam(req, "doaction").equals("search")) { final String searchTerm = getParam(req, "searchterm"); if (!searchTerm.equals("") && !searchTerm.equals(".*")) { handleFilter(req, resp, session, searchTerm); return; } } }
Renders the user homepage that users see when they log in
handleDoAction
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
private void handleFilter(final HttpServletRequest req, final HttpServletResponse resp, final Session session, final String searchTerm) { final User user = session.getUser(); final ProjectManager manager = getApplication().getProjectManager(); final Page page = newPage(req, resp, session, "azkaban/webapp/servlet/velocity/index.vm"); if (hasParam(req, "all")) { // do nothing special if one asks for 'ALL' projects final List<Project> projects = manager.getProjectsByRegex(searchTerm); page.add("allProjects", ""); page.add("projects", projects); page.add("search_term", searchTerm); } else { final List<Project> projects = manager.getUserProjectsByRegex(user, searchTerm); page.add("projects", projects); page.add("search_term", searchTerm); } page.render(); }
Renders the user homepage that users see when they log in
handleFilter
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
@Override protected void handlePost(final HttpServletRequest req, final HttpServletResponse resp, final Session session) throws ServletException, IOException { // TODO Auto-generated method stub }
Renders the user homepage that users see when they log in
handlePost
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
public int getProjectId() { return this.projectId; }
This class is used to represent a simplified project, which can be returned to end users via REST API. This is done in consideration that the API caller only wants certain project level information regarding a project, but does not want every flow and every job inside that project. @author jyu
getProjectId
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
public void setProjectId(final int projectId) { this.projectId = projectId; }
This class is used to represent a simplified project, which can be returned to end users via REST API. This is done in consideration that the API caller only wants certain project level information regarding a project, but does not want every flow and every job inside that project. @author jyu
setProjectId
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
public String getProjectName() { return this.projectName; }
This class is used to represent a simplified project, which can be returned to end users via REST API. This is done in consideration that the API caller only wants certain project level information regarding a project, but does not want every flow and every job inside that project. @author jyu
getProjectName
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
public void setProjectName(final String projectName) { this.projectName = projectName; }
This class is used to represent a simplified project, which can be returned to end users via REST API. This is done in consideration that the API caller only wants certain project level information regarding a project, but does not want every flow and every job inside that project. @author jyu
setProjectName
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
public String getCreatedBy() { return this.createdBy; }
This class is used to represent a simplified project, which can be returned to end users via REST API. This is done in consideration that the API caller only wants certain project level information regarding a project, but does not want every flow and every job inside that project. @author jyu
getCreatedBy
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
public void setCreatedBy(final String createdBy) { this.createdBy = createdBy; }
This class is used to represent a simplified project, which can be returned to end users via REST API. This is done in consideration that the API caller only wants certain project level information regarding a project, but does not want every flow and every job inside that project. @author jyu
setCreatedBy
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
public long getCreatedTime() { return this.createdTime; }
This class is used to represent a simplified project, which can be returned to end users via REST API. This is done in consideration that the API caller only wants certain project level information regarding a project, but does not want every flow and every job inside that project. @author jyu
getCreatedTime
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
public void setCreatedTime(final long createdTime) { this.createdTime = createdTime; }
This class is used to represent a simplified project, which can be returned to end users via REST API. This is done in consideration that the API caller only wants certain project level information regarding a project, but does not want every flow and every job inside that project. @author jyu
setCreatedTime
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
public List<Pair<String, Permission>> getUserPermissions() { return this.userPermissions; }
This class is used to represent a simplified project, which can be returned to end users via REST API. This is done in consideration that the API caller only wants certain project level information regarding a project, but does not want every flow and every job inside that project. @author jyu
getUserPermissions
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
public void setUserPermissions( final List<Pair<String, Permission>> userPermissions) { this.userPermissions = userPermissions; }
This class is used to represent a simplified project, which can be returned to end users via REST API. This is done in consideration that the API caller only wants certain project level information regarding a project, but does not want every flow and every job inside that project. @author jyu
setUserPermissions
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
public List<Pair<String, Permission>> getGroupPermissions() { return this.groupPermissions; }
This class is used to represent a simplified project, which can be returned to end users via REST API. This is done in consideration that the API caller only wants certain project level information regarding a project, but does not want every flow and every job inside that project. @author jyu
getGroupPermissions
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
public void setGroupPermissions( final List<Pair<String, Permission>> groupPermissions) { this.groupPermissions = groupPermissions; }
This class is used to represent a simplified project, which can be returned to end users via REST API. This is done in consideration that the API caller only wants certain project level information regarding a project, but does not want every flow and every job inside that project. @author jyu
setGroupPermissions
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ProjectServlet.java
Apache-2.0
private void ajaxScheduleCronFlow(final HttpServletRequest req, final HashMap<String, Object> ret, final User user) throws ServletException { final String projectName = getParam(req, "projectName"); final String flowName = getParam(req, "flow"); final Project project = this.projectManager.getProject(projectName); if (project == null) { ret.put(PARAM_MESSAGE, "Project " + projectName + " does not exist"); ret.put(PARAM_STATUS, STATUS_ERROR); return; } final int projectId = project.getId(); if (!hasPermission(project, user, Type.SCHEDULE)) { ret.put(PARAM_STATUS, STATUS_ERROR); ret.put(PARAM_MESSAGE, "Permission denied. Cannot execute " + flowName); return; } final Flow flow = project.getFlow(flowName); if (flow == null) { ret.put(PARAM_STATUS, STATUS_ERROR); ret.put(PARAM_MESSAGE, "Flow " + flowName + " cannot be found in project " + projectName); return; } if (flow.isLocked()) { ret.put(PARAM_STATUS, STATUS_ERROR); ret.put(PARAM_MESSAGE, "Flow " + flowName + " in project " + projectName + " is locked."); return; } final boolean hasFlowTrigger; try { hasFlowTrigger = this.projectManager.hasFlowTrigger(project, flow); } catch (final Exception ex) { logger.error("Error looking for flow trigger of flow {}.{}", projectName, flowName); ret.put(PARAM_STATUS, STATUS_ERROR); ret.put(PARAM_MESSAGE, String.format("Error looking for flow trigger of flow: %s.%s ", projectName, flowName)); return; } if (hasFlowTrigger) { ret.put(PARAM_STATUS, STATUS_ERROR); ret.put(PARAM_MESSAGE, String.format("<font color=\"red\"> Error: Flow %s.%s is already " + "associated with flow trigger, so schedule has to be defined in flow trigger config </font>", projectName, flowName)); return; } final DateTimeZone timezone = DateTimeZone.getDefault(); final DateTime firstSchedTime = getPresentTimeByTimezone(timezone); String cronExpression = null; try { if (hasParam(req, "cronExpression")) { // everything in Azkaban functions is at the minute granularity, so we add 0 here // to let the expression to be complete. cronExpression = getParam(req, "cronExpression"); if (azkaban.utils.Utils.isCronExpressionValid(cronExpression, timezone) == false) { ret.put(PARAM_ERROR, "This expression <" + cronExpression + "> can not be parsed to quartz cron."); return; } } if (cronExpression == null) { throw new Exception("Cron expression must exist."); } } catch (final Exception e) { ret.put(PARAM_ERROR, e.getMessage()); } final long endSchedTime = getLongParam(req, "endSchedTime", Constants.DEFAULT_SCHEDULE_END_EPOCH_TIME); try { // Todo kunkun-tang: Need to verify if passed end time is valid. } catch (final Exception e) { ret.put(PARAM_ERROR, "Invalid date and time: " + endSchedTime); return; } ExecutionOptions flowOptions = null; final Props azProps = getApplication().getServerProps(); try { flowOptions = HttpRequestUtils.parseFlowOptions(req, flowName); HttpRequestUtils.filterAdminOnlyFlowParams(this.userManager, flowOptions, user); HttpRequestUtils.validatePreprocessFlowParameters(flowOptions, azProps); } catch (final Exception e) { ret.put(PARAM_ERROR, e.getMessage()); } // TODO: backend backExecute will be in next PR final boolean backExecutionOnceEnabled = getBooleanParam(req, "backExecuteOnce", DEFAULT_BACK_EXECUTE_ONCE_ON_MISSED_SCHEDULE); // Because either cronExpression or recurrence exists, we build schedule in the below way. final Schedule schedule = this.scheduleManager.cronScheduleFlow(-1, projectId, projectName, flowName, "ready", firstSchedTime.getMillis(), endSchedTime, firstSchedTime.getZone(), DateTime.now().getMillis(), firstSchedTime.getMillis(), firstSchedTime.getMillis(), user.getUserId(), flowOptions, cronExpression, backExecutionOnceEnabled); logger.info("User '" + user.getUserId() + "' has scheduled " + "[" + projectName + flowName + " (" + projectId + ")" + "] with backExecuteOnceOnMiss " + (backExecutionOnceEnabled ? "enabled" : "disabled")); this.projectManager.postProjectEvent(project, EventType.SCHEDULE, user.getUserId(), "Schedule " + schedule.toString() + " has been added."); this.projectManager.postScheduleEvent(project, azkaban.spi.EventType.SCHEDULE_CREATED, user, schedule, null); ret.put(PARAM_STATUS, STATUS_SUCCESS); ret.put(PARAM_SCHEDULE_ID, schedule.getScheduleId()); ret.put(PARAM_MESSAGE, projectName + "." + flowName + " scheduled."); }
This method is in charge of doing cron scheduling.
ajaxScheduleCronFlow
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ScheduleServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ScheduleServlet.java
Apache-2.0
private DateTime parseDateTime(final String scheduleDate, final String scheduleTime) { // scheduleTime: 12,00,pm,PDT final String[] parts = scheduleTime.split(",", -1); int hour = Integer.parseInt(parts[0]); final int minutes = Integer.parseInt(parts[1]); final boolean isPm = parts[2].equalsIgnoreCase("pm"); final DateTimeZone timezone = parts[3].equals("UTC") ? DateTimeZone.UTC : DateTimeZone.getDefault(); // scheduleDate: 02/10/2013 DateTime day = null; if (scheduleDate == null || scheduleDate.trim().length() == 0) { day = new LocalDateTime().toDateTime(); } else { day = DateTimeFormat.forPattern("MM/dd/yyyy").withZone(timezone).parseDateTime(scheduleDate); } hour %= 12; if (isPm) { hour += 12; } final DateTime firstSchedTime = day.withHourOfDay(hour).withMinuteOfHour(minutes).withSecondOfMinute(0); return firstSchedTime; }
This method is in charge of doing cron scheduling.
parseDateTime
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ScheduleServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ScheduleServlet.java
Apache-2.0
private DateTimeZone parseTimeZone(final String cronTimezone) { if (cronTimezone != null && cronTimezone.equals("UTC")) { return DateTimeZone.UTC; } return DateTimeZone.getDefault(); }
@param cronTimezone represents the timezone from remote API call @return if the string is equal to UTC, we return UTC; otherwise, we always return default timezone.
parseTimeZone
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ScheduleServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ScheduleServlet.java
Apache-2.0
private DateTime getPresentTimeByTimezone(final DateTimeZone timezone) { return new DateTime(timezone); }
@param cronTimezone represents the timezone from remote API call @return if the string is equal to UTC, we return UTC; otherwise, we always return default timezone.
getPresentTimeByTimezone
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ScheduleServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ScheduleServlet.java
Apache-2.0
public static Set<String> getSetFromString(final String val) { if (val == null || val.trim().length() == 0) { return Collections.emptySet(); } return new HashSet<>(Arrays.asList(val.split("\\s*,\\s*"))); }
Returns the Set of String from the comma-separated val
getSetFromString
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/ServletUtils.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/ServletUtils.java
Apache-2.0
@Override public void init(final ServletConfig config) throws ServletException { super.init(config); final AzkabanWebServer server = getApplication(); this.userManager = server.getUserManager(); this.execManagerAdapter = server.getExecutorManager(); }
User facing servlet for Azkaban default metric display
init
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/StatsServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/StatsServlet.java
Apache-2.0
private static List<AzkabanAPI> createAPIEndpoints() { final List<AzkabanAPI> apiEndpoints = new ArrayList<>(); apiEndpoints.add( new AzkabanAPI(ConnectorParams.ACTION_PARAM, ConnectorParams.STATS_GET_METRICHISTORY)); apiEndpoints.add( new AzkabanAPI(ConnectorParams.ACTION_PARAM, ConnectorParams.STATS_GET_ALLMETRICSNAME)); apiEndpoints.add( new AzkabanAPI(ConnectorParams.ACTION_PARAM, ConnectorParams.STATS_SET_REPORTINGINTERVAL)); apiEndpoints.add( new AzkabanAPI(ConnectorParams.ACTION_PARAM, ConnectorParams.STATS_SET_CLEANINGINTERVAL)); apiEndpoints.add( new AzkabanAPI(ConnectorParams.ACTION_PARAM, ConnectorParams.STATS_SET_MAXREPORTERPOINTS)); apiEndpoints.add( new AzkabanAPI(ConnectorParams.ACTION_PARAM, ConnectorParams.STATS_SET_ENABLEMETRICS)); apiEndpoints.add( new AzkabanAPI(ConnectorParams.ACTION_PARAM, ConnectorParams.STATS_SET_DISABLEMETRICS)); return apiEndpoints; }
User facing servlet for Azkaban default metric display
createAPIEndpoints
java
azkaban/azkaban
azkaban-web-server/src/main/java/azkaban/webapp/servlet/StatsServlet.java
https://github.com/azkaban/azkaban/blob/master/azkaban-web-server/src/main/java/azkaban/webapp/servlet/StatsServlet.java
Apache-2.0