mirror of
https://github.com/google/nomulus.git
synced 2025-08-20 16:34:11 +02:00
Pay off technical debt with ConsoleUiServlet
1. Turn ConsoleUiServlet into an action 2. Remove AbstractUiServlet, which fixes its threading bug 3. Use type-safe soy template parameters when rendering console A follow-up change will add a new template parameter that renders the payment page link on the navigation bar. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=117969638
This commit is contained in:
jart
Justine Tunney
parent
79b2d5a990
commit
b6b13333dd
22 changed files with 265 additions and 365 deletions
|
|
@ -1,105 +0,0 @@
|
|||
// Copyright 2016 Google Inc. All Rights Reserved.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
package com.google.domain.registry.ui.server;
|
||||
|
||||
import static com.google.domain.registry.security.XsrfTokenManager.generateToken;
|
||||
|
||||
import com.google.appengine.api.users.User;
|
||||
import com.google.appengine.api.users.UserService;
|
||||
import com.google.appengine.api.users.UserServiceFactory;
|
||||
import com.google.common.net.MediaType;
|
||||
import com.google.template.soy.data.SoyMapData;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
import javax.servlet.ServletException;
|
||||
import javax.servlet.http.HttpServlet;
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
import javax.servlet.http.HttpServletResponse;
|
||||
|
||||
/** Abstract servlet for serving HTML pages. */
|
||||
public abstract class AbstractUiServlet extends HttpServlet {
|
||||
|
||||
protected String userId;
|
||||
protected String userName;
|
||||
protected String userActionName;
|
||||
protected String userActionHref;
|
||||
protected boolean userIsAdmin;
|
||||
|
||||
@Override
|
||||
public void service(HttpServletRequest req, HttpServletResponse rsp)
|
||||
throws ServletException, IOException {
|
||||
UserService userService = UserServiceFactory.getUserService();
|
||||
if (userService.isUserLoggedIn()) {
|
||||
User u = userService.getCurrentUser();
|
||||
userId = u.getUserId();
|
||||
userName = u.getNickname();
|
||||
userActionName = "Sign out";
|
||||
userActionHref = userService.createLogoutURL(req.getRequestURI());
|
||||
userIsAdmin = userService.isUserAdmin();
|
||||
} else {
|
||||
userId = null;
|
||||
userName = null;
|
||||
userActionName = "Sign in";
|
||||
userActionHref = userService.createLoginURL(req.getRequestURI());
|
||||
userIsAdmin = false;
|
||||
}
|
||||
super.service(req, rsp);
|
||||
}
|
||||
|
||||
@Override
|
||||
public void doGet(HttpServletRequest req, HttpServletResponse rsp)
|
||||
throws ServletException, IOException {
|
||||
rsp.addHeader("X-Frame-Options", "SAMEORIGIN"); // Disallow iframing.
|
||||
rsp.setHeader("X-Ui-Compatible", "IE=edge"); // Ask IE not to be silly.
|
||||
rsp.setContentType(MediaType.HTML_UTF_8.toString());
|
||||
UserService userService = UserServiceFactory.getUserService();
|
||||
if (!userService.isUserLoggedIn()) {
|
||||
rsp.sendRedirect(userService.createLoginURL(req.getRequestURI()));
|
||||
return;
|
||||
}
|
||||
rsp.getWriter().write(get(req));
|
||||
}
|
||||
|
||||
/**
|
||||
* Subclasses may override this method to access request params, or
|
||||
* get() to simply return content.
|
||||
*/
|
||||
protected String get(@SuppressWarnings("unused") HttpServletRequest req) {
|
||||
return get();
|
||||
}
|
||||
|
||||
/** Override this to just return content. */
|
||||
protected String get() {
|
||||
throw new UnsupportedOperationException();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a map with {@code (user: (id,name,actionName,actionHref), gaeUserId:, xsrfToken:)}
|
||||
*/
|
||||
protected SoyMapData getTemplateArgs(String xsrfToken) {
|
||||
SoyMapData user = new SoyMapData();
|
||||
user.put("id", userId);
|
||||
user.put("name", userName);
|
||||
user.put("actionName", userActionName);
|
||||
user.put("actionHref", userActionHref);
|
||||
user.put("isAdmin", userIsAdmin);
|
||||
SoyMapData result = new SoyMapData();
|
||||
result.put("user", user);
|
||||
result.put("gaeUserId", userId);
|
||||
result.put("xsrfToken", generateToken(xsrfToken));
|
||||
return result;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,106 @@
|
|||
// Copyright 2016 Google Inc. All Rights Reserved.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
package com.google.domain.registry.ui.server.registrar;
|
||||
|
||||
import static com.google.common.net.HttpHeaders.X_FRAME_OPTIONS;
|
||||
import static javax.servlet.http.HttpServletResponse.SC_FORBIDDEN;
|
||||
import static javax.servlet.http.HttpServletResponse.SC_SERVICE_UNAVAILABLE;
|
||||
|
||||
import com.google.appengine.api.users.UserService;
|
||||
import com.google.common.annotations.VisibleForTesting;
|
||||
import com.google.common.base.Supplier;
|
||||
import com.google.common.io.Resources;
|
||||
import com.google.common.net.MediaType;
|
||||
import com.google.domain.registry.config.ConfigModule.Config;
|
||||
import com.google.domain.registry.flows.EppConsoleServlet;
|
||||
import com.google.domain.registry.model.registrar.Registrar;
|
||||
import com.google.domain.registry.request.Action;
|
||||
import com.google.domain.registry.request.Response;
|
||||
import com.google.domain.registry.security.XsrfTokenManager;
|
||||
import com.google.domain.registry.ui.server.SoyTemplateUtils;
|
||||
import com.google.domain.registry.ui.soy.registrar.ConsoleSoyInfo;
|
||||
import com.google.template.soy.data.SoyMapData;
|
||||
import com.google.template.soy.shared.SoyCssRenamingMap;
|
||||
import com.google.template.soy.tofu.SoyTofu;
|
||||
|
||||
import javax.inject.Inject;
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
|
||||
/** Action that serves Registrar Console single HTML page (SPA). */
|
||||
@Action(path = ConsoleUiAction.PATH, requireLogin = true, xsrfProtection = false)
|
||||
public final class ConsoleUiAction implements Runnable {
|
||||
|
||||
public static final String PATH = "/registrar";
|
||||
|
||||
private static final Supplier<SoyTofu> TOFU_SUPPLIER =
|
||||
SoyTemplateUtils.createTofuSupplier(
|
||||
com.google.domain.registry.ui.soy.ConsoleSoyInfo.getInstance(),
|
||||
com.google.domain.registry.ui.soy.registrar.ConsoleSoyInfo.getInstance());
|
||||
|
||||
@VisibleForTesting // webdriver and screenshot tests need this
|
||||
public static final Supplier<SoyCssRenamingMap> CSS_RENAMING_MAP_SUPPLIER =
|
||||
SoyTemplateUtils.createCssRenamingMapSupplier(
|
||||
Resources.getResource("com/google/domain/registry/ui/css/registrar_bin.css.js"),
|
||||
Resources.getResource("com/google/domain/registry/ui/css/registrar_dbg.css.js"));
|
||||
|
||||
@Inject HttpServletRequest req;
|
||||
@Inject Response response;
|
||||
@Inject SessionUtils sessionUtils;
|
||||
@Inject UserService userService;
|
||||
@Inject @Config("registrarConsoleEnabled") boolean enabled;
|
||||
@Inject ConsoleUiAction() {}
|
||||
|
||||
@Override
|
||||
public void run() {
|
||||
response.setContentType(MediaType.HTML_UTF_8);
|
||||
response.setHeader(X_FRAME_OPTIONS, "SAMEORIGIN"); // Disallow iframing.
|
||||
response.setHeader("X-Ui-Compatible", "IE=edge"); // Ask IE not to be silly.
|
||||
if (!enabled) {
|
||||
response.setStatus(SC_SERVICE_UNAVAILABLE);
|
||||
response.setPayload(
|
||||
TOFU_SUPPLIER.get()
|
||||
.newRenderer(ConsoleSoyInfo.DISABLED)
|
||||
.setCssRenamingMap(CSS_RENAMING_MAP_SUPPLIER.get())
|
||||
.render());
|
||||
return;
|
||||
}
|
||||
if (!sessionUtils.checkRegistrarConsoleLogin(req)) {
|
||||
SoyMapData data = new SoyMapData();
|
||||
data.put("username", userService.getCurrentUser().getNickname());
|
||||
data.put("logoutUrl", userService.createLogoutURL(PATH));
|
||||
response.setStatus(SC_FORBIDDEN);
|
||||
response.setPayload(
|
||||
TOFU_SUPPLIER.get()
|
||||
.newRenderer(ConsoleSoyInfo.WHOAREYOU)
|
||||
.setCssRenamingMap(CSS_RENAMING_MAP_SUPPLIER.get())
|
||||
.setData(data)
|
||||
.render());
|
||||
return;
|
||||
}
|
||||
Registrar registrar = Registrar.loadByClientId(sessionUtils.getRegistrarClientId(req));
|
||||
SoyMapData data = new SoyMapData();
|
||||
data.put("xsrfToken", XsrfTokenManager.generateToken(EppConsoleServlet.XSRF_SCOPE));
|
||||
data.put("clientId", registrar.getClientIdentifier());
|
||||
data.put("username", userService.getCurrentUser().getNickname());
|
||||
data.put("isAdmin", userService.isUserAdmin());
|
||||
data.put("logoutUrl", userService.createLogoutURL(PATH));
|
||||
response.setPayload(
|
||||
TOFU_SUPPLIER.get()
|
||||
.newRenderer(ConsoleSoyInfo.MAIN)
|
||||
.setCssRenamingMap(CSS_RENAMING_MAP_SUPPLIER.get())
|
||||
.setData(data)
|
||||
.render());
|
||||
}
|
||||
}
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
// Copyright 2016 Google Inc. All Rights Reserved.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
|
||||
package com.google.domain.registry.ui.server.registrar;
|
||||
|
||||
import com.google.appengine.api.users.UserServiceFactory;
|
||||
import com.google.common.annotations.VisibleForTesting;
|
||||
import com.google.common.base.Supplier;
|
||||
import com.google.common.io.Resources;
|
||||
import com.google.domain.registry.config.RegistryEnvironment;
|
||||
import com.google.domain.registry.flows.EppConsoleServlet;
|
||||
import com.google.domain.registry.ui.server.AbstractUiServlet;
|
||||
import com.google.domain.registry.ui.server.SoyTemplateUtils;
|
||||
import com.google.domain.registry.ui.soy.registrar.ConsoleSoyInfo;
|
||||
import com.google.domain.registry.util.NonFinalForTesting;
|
||||
import com.google.template.soy.data.SoyMapData;
|
||||
import com.google.template.soy.shared.SoyCssRenamingMap;
|
||||
import com.google.template.soy.tofu.SoyTofu;
|
||||
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
|
||||
/** Main registrar console servlet that serves the client code. */
|
||||
public final class ConsoleUiServlet extends AbstractUiServlet {
|
||||
|
||||
@VisibleForTesting
|
||||
static final Supplier<SoyTofu> TOFU_SUPPLIER =
|
||||
SoyTemplateUtils.createTofuSupplier(
|
||||
com.google.domain.registry.ui.soy.ConsoleSoyInfo.getInstance(),
|
||||
com.google.domain.registry.ui.soy.registrar.ConsoleSoyInfo.getInstance());
|
||||
|
||||
@VisibleForTesting
|
||||
public static final Supplier<SoyCssRenamingMap> CSS_RENAMING_MAP_SUPPLIER =
|
||||
SoyTemplateUtils.createCssRenamingMapSupplier(
|
||||
Resources.getResource("com/google/domain/registry/ui/css/registrar_bin.css.js"),
|
||||
Resources.getResource("com/google/domain/registry/ui/css/registrar_dbg.css.js"));
|
||||
|
||||
@NonFinalForTesting
|
||||
private static SessionUtils sessionUtils = new SessionUtils(UserServiceFactory.getUserService());
|
||||
|
||||
@Override
|
||||
protected String get(HttpServletRequest req) {
|
||||
if (!RegistryEnvironment.get().config().isRegistrarConsoleEnabled()) {
|
||||
return TOFU_SUPPLIER.get()
|
||||
.newRenderer(ConsoleSoyInfo.DISABLED)
|
||||
.setCssRenamingMap(CSS_RENAMING_MAP_SUPPLIER.get())
|
||||
.render();
|
||||
}
|
||||
|
||||
SoyMapData data = getTemplateArgs(EppConsoleServlet.XSRF_SCOPE);
|
||||
if (!sessionUtils.checkRegistrarConsoleLogin(req)) {
|
||||
data.getMapData("user").put("actionName", "Logout and switch to another account");
|
||||
return TOFU_SUPPLIER.get()
|
||||
.newRenderer(ConsoleSoyInfo.WHOAREYOU)
|
||||
.setCssRenamingMap(CSS_RENAMING_MAP_SUPPLIER.get())
|
||||
.setData(data)
|
||||
.render();
|
||||
}
|
||||
data.put("clientId", req.getSession().getAttribute(SessionUtils.CLIENT_ID_ATTRIBUTE));
|
||||
return TOFU_SUPPLIER.get()
|
||||
.newRenderer(ConsoleSoyInfo.MAIN)
|
||||
.setCssRenamingMap(CSS_RENAMING_MAP_SUPPLIER.get())
|
||||
.setData(data)
|
||||
.render();
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue