Utils.java

/*
 * Copyright 2014-2016 CyberVision, Inc.
 *
 * 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 org.kaaproject.kaa.server.admin.client.util;

import static com.google.gwt.i18n.client.DateTimeFormat.getFormat;

import com.google.gwt.core.client.GWT;
import com.google.gwt.http.client.Response;
import com.google.gwt.i18n.client.DateTimeFormat;
import com.google.gwt.regexp.shared.RegExp;
import com.google.gwt.user.client.Window;
import com.google.gwt.user.client.rpc.IncompatibleRemoteServiceException;
import com.google.gwt.user.client.rpc.StatusCodeException;

import org.kaaproject.avro.ui.gwt.client.AvroUiResources;
import org.kaaproject.avro.ui.gwt.client.AvroUiResources.AvroUiStyle;
import org.kaaproject.avro.ui.gwt.client.widget.AlertPanel;
import org.kaaproject.kaa.common.dto.VersionDto;
import org.kaaproject.kaa.common.dto.ctl.CTLSchemaScopeDto;
import org.kaaproject.kaa.server.admin.client.KaaAdminResources;
import org.kaaproject.kaa.server.admin.client.KaaAdminResources.KaaAdminStyle;
import org.kaaproject.kaa.server.admin.client.KaaAdminResources.KaaTheme;
import org.kaaproject.kaa.server.admin.client.i18n.KaaAdminConstants;
import org.kaaproject.kaa.server.admin.client.i18n.KaaAdminMessages;
import org.kaaproject.kaa.server.admin.client.mvp.view.dialog.MessageDialog;
import org.kaaproject.kaa.server.admin.client.mvp.view.dialog.UnauthorizedSessionDialog;
import org.kaaproject.kaa.server.admin.shared.services.KaaAdminServiceException;
import org.kaaproject.kaa.server.admin.shared.services.ServiceErrorCode;

import java.util.Collections;
import java.util.Date;
import java.util.List;

public class Utils {

  public static final KaaAdminResources resources = GWT.create(KaaAdminResources.class);
  public static final KaaAdminConstants constants = GWT.create(KaaAdminConstants.class);
  public static final KaaAdminMessages messages = GWT.create(KaaAdminMessages.class);
  public static final AvroUiResources avroUiResources = GWT.create(AvroUiResources.class);
  public static final KaaTheme kaaTheme = resources.kaaTheme();
  public static final KaaAdminStyle kaaAdminStyle = resources.kaaAdminStyle();
  public static final AvroUiStyle avroUiStyle = avroUiResources.avroUiStyle();
  private static final int MAX_ERROR_LINE_LENGTH = 200;
  private static final RegExp emailPattern = RegExp.compile("^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*"
          + "|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@"
          + "(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)*[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)"
          + "\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]"
          + "|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])$", "i");

  private static final DateTimeFormat simpleDateFormat = getFormat("MM/dd/yyyy");

  private static final DateTimeFormat simpleDateTimeFormat = getFormat("MM/dd/yyyy h:mm a");

  private static final int INCORRECT_IDX = -1;

  private static UnauthorizedSessionDialog unauthorizedSessionDialog;

  /**
   * Inject Kaa styles.
   */
  public static void injectKaaStyles() {
    kaaTheme.ensureInjected();
    kaaAdminStyle.ensureInjected();
    avroUiStyle.ensureInjected();
  }

  public static void handleException(Throwable caught,
                                     HasErrorMessage hasErrorMessage) {
    handleException(caught, hasErrorMessage, null);
  }

  /**
   * Exception handler.
   */
  public static void handleException(Throwable caught,
                                     HasErrorMessage hasErrorMessage,
                                     ErrorMessageCustomizer errorMessageCustomizer) {
    boolean handled = false;
    if (caught instanceof StatusCodeException) {
      StatusCodeException sce = (StatusCodeException) caught;
      if (sce.getStatusCode() == Response.SC_UNAUTHORIZED) {
        onUnauthorized();
        handled = true;
      } else if (sce.getStatusCode() == 0) {
        handleNetworkConnectionError();
        handled = true;
      }
    } else if (caught instanceof IncompatibleRemoteServiceException) {
      MessageDialog.showMessageDialog(AlertPanel.Type.ERROR, constants.incompatibleRemoteService(),
          messages.incompatibleRemoteService());
      handled = true;
    }
    if (!handled) {
      String message = parseErrorMessage(caught, errorMessageCustomizer);
      String[] lines = message.split("\r\n|\r|\n");
      if (lines.length > 1 || (lines.length == 1 && lines[0].length() >= MAX_ERROR_LINE_LENGTH)) {
        MessageDialog.showMessageDialog(AlertPanel.Type.ERROR, constants.errorTitle(), message);
      } else {
        hasErrorMessage.setErrorMessage(message);
      }
    }
  }

  public static void handleNetworkConnectionError() {
    MessageDialog.showMessageDialog(AlertPanel.Type.ERROR, constants.serverIsUnreachable(),
        messages.serverIsUnreacheableMessage());
  }

  public static String parseErrorMessage(Throwable caught) {
    return parseErrorMessage(caught, null);
  }

  private static String parseErrorMessage(Throwable caught,
                                          ErrorMessageCustomizer errorMessageCustomizer) {
    if (errorMessageCustomizer != null) {
      return errorMessageCustomizer.customizeErrorMessage(caught);
    } else if (caught instanceof KaaAdminServiceException) {
      ServiceErrorCode errorCode = ((KaaAdminServiceException) caught)
          .getErrorCode();
      String message = constants.getString(errorCode.getResKey());
      if (errorCode.showErrorMessage()) {
        message += caught.getLocalizedMessage();
      }
      return message;
    } else {
      return caught.getLocalizedMessage();
    }
  }

  private static void onUnauthorized() {
    if (unauthorizedSessionDialog == null
        || !unauthorizedSessionDialog.isShowing()) {
      unauthorizedSessionDialog = new UnauthorizedSessionDialog(
          new UnauthorizedSessionDialog.Listener() {
            @Override
            public void onLogin() {
              Window.open(Window.Location.getPath(), "_blank", "");
            }

            @Override
            public void onIgnore() {
              // do nothing
            }
          });
      unauthorizedSessionDialog.center();
      unauthorizedSessionDialog.show();
    }
  }

  public static String millisecondsToDateString(long millis) {
    return simpleDateFormat.format(new Date(millis));
  }

  public static String millisecondsToDateTimeString(long millis) {
    return simpleDateTimeFormat.format(new Date(millis));
  }

  /**
   * Validate email.
   *
   * @param mail the email address
   * @return boolean 'true' if email address is valid
   */
  public static boolean validateEmail(String mail) {
    return !(mail == null || mail.length() == 0) && emailPattern.exec(mail) != null;
  }

  /**
   * Get maximum schema versions.
   *
   * @param schemas the list of schemas
   * @return maximum schema versions
   */
  public static <T extends VersionDto> T getMaxSchemaVersions(List<T> schemas) {
    if (schemas != null && !schemas.isEmpty()) {
      return Collections.max(schemas);
    } else {
      return null;
    }
  }

  public static boolean isNotBlank(String string) {
    return string != null && string.length() > 0;
  }

  public static boolean isBlank(String string) {
    return string == null || string.length() == 0;
  }

  /**
   * Get CTL scope.
   *
   * @param scope the CTL schema scope DTO
   * @return the CTL schema scope.
   */
  public static String getCtlScopeString(CTLSchemaScopeDto scope) {
    switch (scope) {
      case APPLICATION:
        return constants.scopeApplication();
      case SYSTEM:
        return constants.scopeSystem();
      case TENANT:
        return constants.scopeTenant();
      default:
        return "Unknown";
    }
  }

  /**
   * Get CTL schema scope title.
   *
   * @param scope the CTL schema scope DTO
   * @return the CTL schema scope title.
   */
  public static String getCtlScopeTitleString(CTLSchemaScopeDto scope) {
    switch (scope) {
      case APPLICATION:
        return constants.scopeApplicationTitle();
      case SYSTEM:
        return constants.scopeSystemTitle();
      case TENANT:
        return constants.scopeTenantTitle();
      default:
        return "Unknown";
    }
  }

  public static String getSchemaIdFromUrl(String path) {
    String[] pathArray = path.split("&");
    return pathArray[pathArray.length - 1].split("=")[1];
  }

  public static String getEndpointGroupIdFromUrl(String path) {
    return path.split("&")[1].split("=")[1];
  }

  /**
   * Abbreviates a long string using ellipsis.
   *
   * @param text      The string to abbreviate
   * @param maxLength The maximum length of the resulting string
   * @return The abbreviated string
   */
  public static String abbreviateText(String text, int maxLength) {
    return (text != null
        && text.length() > maxLength) ? text.substring(0, maxLength) + "..." : text;
  }
}