path: root/android/src/com/mapswithme/maps/Framework.java

package com.mapswithme.maps;

import android.graphics.Bitmap;
import android.location.Location;
import androidx.annotation.IntDef;
import androidx.annotation.MainThread;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.Size;
import androidx.annotation.UiThread;
import android.text.TextUtils;

import com.mapswithme.maps.ads.Banner;
import com.mapswithme.maps.ads.LocalAdInfo;
import com.mapswithme.maps.api.ParsedRoutingData;
import com.mapswithme.maps.api.ParsedSearchRequest;
import com.mapswithme.maps.api.ParsedUrlMwmRequest;
import com.mapswithme.maps.auth.AuthorizationListener;
import com.mapswithme.maps.background.NotificationCandidate;
import com.mapswithme.maps.bookmarks.data.DistanceAndAzimut;
import com.mapswithme.maps.bookmarks.data.MapObject;
import com.mapswithme.maps.downloader.DownloaderPromoBanner;
import com.mapswithme.maps.gdpr.UserBindingListener;
import com.mapswithme.maps.location.LocationHelper;
import com.mapswithme.maps.routing.RouteMarkData;
import com.mapswithme.maps.routing.RoutePointInfo;
import com.mapswithme.maps.routing.RoutingInfo;
import com.mapswithme.maps.routing.TransitRouteInfo;
import com.mapswithme.maps.search.FilterUtils;
import com.mapswithme.maps.settings.SettingsPrefsFragment;
import com.mapswithme.util.Constants;
import com.mapswithme.util.log.Logger;
import com.mapswithme.util.log.LoggerFactory;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * This class wraps android::Framework.cpp class
 * via static methods
 */
public class Framework
{
  private static final Logger LOGGER = LoggerFactory.INSTANCE.getLogger(LoggerFactory.Type.MISC);
  private static final String TAG = Framework.class.getSimpleName();

  @Retention(RetentionPolicy.SOURCE)
  @IntDef({MAP_STYLE_CLEAR, MAP_STYLE_DARK, MAP_STYLE_VEHICLE_CLEAR, MAP_STYLE_VEHICLE_DARK})

  public @interface MapStyle {}

  public static final int MAP_STYLE_CLEAR = 0;
  public static final int MAP_STYLE_DARK = 1;
  public static final int MAP_STYLE_VEHICLE_CLEAR = 3;
  public static final int MAP_STYLE_VEHICLE_DARK = 4;

  @Retention(RetentionPolicy.SOURCE)
  @IntDef({ ROUTER_TYPE_VEHICLE, ROUTER_TYPE_PEDESTRIAN, ROUTER_TYPE_BICYCLE, ROUTER_TYPE_TAXI,
            ROUTER_TYPE_TRANSIT })

  public @interface RouterType {}

  public static final int ROUTER_TYPE_VEHICLE = 0;
  public static final int ROUTER_TYPE_PEDESTRIAN = 1;
  public static final int ROUTER_TYPE_BICYCLE = 2;
  public static final int ROUTER_TYPE_TAXI = 3;
  public static final int ROUTER_TYPE_TRANSIT = 4;

  @Retention(RetentionPolicy.SOURCE)
  @IntDef({DO_AFTER_UPDATE_NOTHING, DO_AFTER_UPDATE_AUTO_UPDATE, DO_AFTER_UPDATE_ASK_FOR_UPDATE})
  public @interface DoAfterUpdate {}

  public static final int DO_AFTER_UPDATE_NOTHING = 0;
  public static final int DO_AFTER_UPDATE_AUTO_UPDATE = 1;
  public static final int DO_AFTER_UPDATE_ASK_FOR_UPDATE = 2;

  @Retention(RetentionPolicy.SOURCE)
  @IntDef({ROUTE_REBUILD_AFTER_POINTS_LOADING})
  public @interface RouteRecommendationType {}

  public static final int ROUTE_REBUILD_AFTER_POINTS_LOADING = 0;

  @Retention(RetentionPolicy.SOURCE)
  @IntDef({ SOCIAL_TOKEN_INVALID, SOCIAL_TOKEN_FACEBOOK, SOCIAL_TOKEN_GOOGLE,
            SOCIAL_TOKEN_PHONE, TOKEN_MAPSME })
  public @interface AuthTokenType
  {}
  public static final int SOCIAL_TOKEN_INVALID = -1;
  public static final int SOCIAL_TOKEN_FACEBOOK = 0;
  public static final int SOCIAL_TOKEN_GOOGLE = 1;
  public static final int SOCIAL_TOKEN_PHONE = 2;
  //TODO(@alexzatsepin): remove TOKEN_MAPSME from this list.
  public static final int TOKEN_MAPSME = 3;

  @Retention(RetentionPolicy.SOURCE)
  @IntDef({ PURCHASE_VERIFIED, PURCHASE_NOT_VERIFIED,
            PURCHASE_VALIDATION_SERVER_ERROR, PURCHASE_VALIDATION_AUTH_ERROR })
  public @interface PurchaseValidationCode {}

  public static final int PURCHASE_VERIFIED = 0;
  public static final int PURCHASE_NOT_VERIFIED = 1;
  public static final int PURCHASE_VALIDATION_SERVER_ERROR = 2;
  public static final int PURCHASE_VALIDATION_AUTH_ERROR = 3;

  @Retention(RetentionPolicy.SOURCE)
  @IntDef({ SUBSCRIPTION_TYPE_REMOVE_ADS, SUBSCRIPTION_TYPE_BOOKMARK_CATALOG })
  public @interface SubscriptionType {}
  public static final int SUBSCRIPTION_TYPE_REMOVE_ADS = 0;
  public static final int SUBSCRIPTION_TYPE_BOOKMARK_CATALOG = 1;

  @SuppressWarnings("unused")
  public interface MapObjectListener
  {
    void onMapObjectActivated(MapObject object);

    void onDismiss(boolean switchFullScreenMode);
  }

  @SuppressWarnings("unused")
  public interface RoutingListener
  {
    @MainThread
    void onRoutingEvent(int resultCode, String[] missingMaps);
  }

  @SuppressWarnings("unused")
  public interface RoutingProgressListener
  {
    @MainThread
    void onRouteBuildingProgress(float progress);
  }

  @SuppressWarnings("unused")
  public interface RoutingRecommendationListener
  {
    void onRecommend(@RouteRecommendationType int recommendation);
  }

  @SuppressWarnings("unused")
  public interface RoutingLoadPointsListener
  {
    void onRoutePointsLoaded(boolean success);
  }

  @SuppressWarnings("unused")
  public interface PurchaseValidationListener
  {
    void onValidatePurchase(@PurchaseValidationCode int code, @NonNull String serverId,
                            @NonNull String vendorId, @NonNull String encodedPurchaseData);
  }

  @SuppressWarnings("unused")
  public interface StartTransactionListener
  {
    void onStartTransaction(boolean success, @NonNull String serverId, @NonNull String vendorId);
  }

  public static class Params3dMode
  {
    public boolean enabled;
    public boolean buildings;
  }

  public static class RouteAltitudeLimits
  {
    public int minRouteAltitude;
    public int maxRouteAltitude;
    public boolean isMetricUnits;
  }

  // this class is just bridge between Java and C++ worlds, we must not create it
  private Framework() {}

  public static String getHttpGe0Url(double lat, double lon, double zoomLevel, String name)
  {
    return nativeGetGe0Url(lat, lon, zoomLevel, name).replaceFirst(Constants.Url.GE0_PREFIX, Constants.Url.HTTP_GE0_PREFIX);
  }

  /**
   * Generates Bitmap with route altitude image chart taking into account current map style.
   * @param width is width of the image.
   * @param height is height of the image.
   * @return Bitmap if there's pedestrian or bicycle route and null otherwise.
   */
  @Nullable
  public static Bitmap generateRouteAltitudeChart(int width, int height,
                                                  @NonNull RouteAltitudeLimits limits)
  {
    if (width <= 0 || height <= 0)
      return null;

    final int[] altitudeChartBits = Framework.nativeGenerateRouteAltitudeChartBits(width, height,
                                                                                   limits);
    if (altitudeChartBits == null)
      return null;

    return Bitmap.createBitmap(altitudeChartBits, width, height, Bitmap.Config.ARGB_8888);
  }

  public static void logLocalAdsEvent(@NonNull LocalAdsEventType type,
                                      @NonNull MapObject mapObject)
  {
    LocalAdInfo info = mapObject.getLocalAdInfo();
    if (info == null || (!info.isCustomer() && !info.isHidden()))
      return;

    Location location = LocationHelper.INSTANCE.getLastKnownLocation();
    double lat = location != null ? location.getLatitude() : 0;
    double lon = location != null ? location.getLongitude() : 0;
    int accuracy = location != null ? (int) location.getAccuracy() : 0;
    nativeLogLocalAdsEvent(type.ordinal(), lat, lon, accuracy);
  }

  @FilterUtils.RatingDef
  public static int getFilterRating(@Nullable String ratingString)
  {
    if (TextUtils.isEmpty(ratingString))
      return FilterUtils.RATING_ANY;

    try
    {
      float rawRating = Float.valueOf(ratingString);
      return Framework.nativeGetFilterRating(rawRating);
    }
    catch (NumberFormatException e)
    {
      LOGGER.w(TAG, "Rating string is not valid: " + ratingString);
    }

    return FilterUtils.RATING_ANY;
  }

  public static void disableAdProvider(@NonNull Banner.Type type)
  {
    nativeDisableAdProvider(type.ordinal(), Banner.Place.DEFAULT.ordinal());
  }

  public static void setSpeedCamerasMode(@NonNull SettingsPrefsFragment.SpeedCameraMode mode)
  {
    nativeSetSpeedCamManagerMode(mode.ordinal());
  }

  public static native void nativeShowTrackRect(long track);

  public static native int nativeGetDrawScale();
  
  public static native int nativePokeSearchInViewport();

  @Size(2)
  public static native double[] nativeGetScreenRectCenter();

  public static native DistanceAndAzimut nativeGetDistanceAndAzimuth(double dstMerX, double dstMerY, double srcLat, double srcLon, double north);

  public static native DistanceAndAzimut nativeGetDistanceAndAzimuthFromLatLon(double dstLat, double dstLon, double srcLat, double srcLon, double north);

  public static native String nativeFormatLatLon(double lat, double lon, boolean useDmsFormat);

  @Size(2)
  public static native String[] nativeFormatLatLonToArr(double lat, double lon, boolean useDmsFormat);

  public static native String nativeFormatAltitude(double alt);

  public static native String nativeFormatSpeed(double speed);

  public static native String nativeGetGe0Url(double lat, double lon, double zoomLevel, String name);

  public static native String nativeGetAddress(double lat, double lon);

  public static native void nativeSetMapObjectListener(MapObjectListener listener);

  public static native void nativeRemoveMapObjectListener();

  @UiThread
  public static native String nativeGetOutdatedCountriesString();

  @UiThread
  @NonNull
  public static native String[] nativeGetOutdatedCountries();

  @UiThread
  @DoAfterUpdate
  public static native int nativeToDoAfterUpdate();

  public static native boolean nativeIsDataVersionChanged();

  public static native void nativeUpdateSavedDataVersion();

  public static native long nativeGetDataVersion();

  public static native void nativeClearApiPoints();
  @ParsedUrlMwmRequest.ParsingResult
  public static native int nativeParseAndSetApiUrl(String url);
  public static native ParsedRoutingData nativeGetParsedRoutingData();
  public static native ParsedSearchRequest nativeGetParsedSearchRequest();

  public static native void nativeDeactivatePopup();

  public static native String[] nativeGetMovableFilesExts();

  public static native String nativeGetBookmarksExt();

  public static native String nativeGetBookmarkDir();

  public static native String nativeGetSettingsDir();

  public static native String nativeGetWritableDir();

  public static native void nativeSetWritableDir(String newPath);

  // Routing.
  public static native boolean nativeIsRoutingActive();

  public static native boolean nativeIsRouteBuilt();

  public static native boolean nativeIsRouteBuilding();

  public static native void nativeCloseRouting();

  public static native void nativeBuildRoute();

  public static native void nativeRemoveRoute();

  public static native void nativeFollowRoute();

  public static native void nativeDisableFollowing();

  public static native String nativeGetUserAgent();

  public static native String nativeGetDeviceId();

  @Nullable
  public static native RoutingInfo nativeGetRouteFollowingInfo();

  @Nullable
  public static native final int[] nativeGenerateRouteAltitudeChartBits(int width, int height, RouteAltitudeLimits routeAltitudeLimits);

  // When an end user is going to a turn he gets sound turn instructions.
  // If C++ part wants the client to pronounce an instruction nativeGenerateTurnNotifications returns
  // an array of one of more strings. C++ part assumes that all these strings shall be pronounced by the client's TTS.
  // For example if C++ part wants the client to pronounce "Make a right turn." this method returns
  // an array with one string "Make a right turn.". The next call of the method returns nothing.
  // nativeGenerateTurnNotifications shall be called by the client when a new position is available.
  @Nullable
  public static native String[] nativeGenerateNotifications();

  private static native void nativeSetSpeedCamManagerMode(int mode);

  public static native void nativeSetRoutingListener(RoutingListener listener);

  public static native void nativeSetRouteProgressListener(RoutingProgressListener listener);

  public static native void nativeSetRoutingRecommendationListener(RoutingRecommendationListener listener);

  public static native void nativeSetRoutingLoadPointsListener(
      @Nullable RoutingLoadPointsListener listener);

  public static native void nativeShowCountry(String countryId, boolean zoomToDownloadButton);

  public static native void nativeSetMapStyle(int mapStyle);

  @MapStyle
  public static native int nativeGetMapStyle();

  /**
   * This method allows to set new map style without immediate applying. It can be used before
   * engine recreation instead of nativeSetMapStyle to avoid huge flow of OpenGL invocations.
   * @param mapStyle style index
   */
  public static native void nativeMarkMapStyle(int mapStyle);

  public static native void nativeSetRouter(@RouterType int routerType);
  @RouterType
  public static native int nativeGetRouter();
  @RouterType
  public static native int nativeGetLastUsedRouter();
  @RouterType
  public static native int nativeGetBestRouter(double srcLat, double srcLon,
                                               double dstLat, double dstLon);

  public static native void nativeAddRoutePoint(String title, String subtitle,
                                                @RoutePointInfo.RouteMarkType int markType,
                                                int intermediateIndex, boolean isMyPosition,
                                                double lat, double lon);

  public static native void nativeRemoveRoutePoint(@RoutePointInfo.RouteMarkType int markType,
                                                   int intermediateIndex);

  public static native void nativeRemoveIntermediateRoutePoints();

  public static native boolean nativeCouldAddIntermediatePoint();
  @NonNull
  public static native RouteMarkData[] nativeGetRoutePoints();
  @NonNull
  public static native TransitRouteInfo nativeGetTransitRouteInfo();
  /**
   * Registers all maps(.mwms). Adds them to the models, generates indexes and does all necessary stuff.
   */
  public static native void nativeRegisterMaps();

  public static native void nativeDeregisterMaps();

  /**
   * Determines if currently is day or night at the given location. Used to switch day/night styles.
   * @param utcTimeSeconds Unix time in seconds.
   * @param lat latitude of the current location.
   * @param lon longitude of the current location.
   * @return {@code true} if it is day now or {@code false} otherwise.
   */
  public static native boolean nativeIsDayTime(long utcTimeSeconds, double lat, double lon);

  public static native void nativeGet3dMode(Params3dMode result);

  public static native void nativeSet3dMode(boolean allow3d, boolean allow3dBuildings);

  public static native boolean nativeGetAutoZoomEnabled();

  public static native void nativeSetAutoZoomEnabled(boolean enabled);

  public static native void nativeSetTransitSchemeEnabled(boolean enabled);

  public static native void nativeSaveSettingSchemeEnabled(boolean enabled);

  public static native boolean nativeIsTransitSchemeEnabled();

  @NonNull
  public static native MapObject nativeDeleteBookmarkFromMapObject();

  public static native void nativeZoomToPoint(double lat, double lon, int zoom, boolean animate);

  /**
   * @param isBusiness selection area will be bounded by building borders, if its true(eg. true for businesses in buildings).
   * @param applyPosition if true, map'll be animated to currently selected object.
   */
  public static native void nativeTurnOnChoosePositionMode(boolean isBusiness, boolean applyPosition);
  public static native void nativeTurnOffChoosePositionMode();
  public static native boolean nativeIsInChoosePositionMode();
  public static native boolean nativeIsDownloadedMapAtScreenCenter();
  public static native String nativeGetActiveObjectFormattedCuisine();

  public static native void nativeSetVisibleRect(int left, int top, int right, int bottom);

  // Navigation.
  public static native boolean nativeIsRouteFinished();

  private static native void nativeLogLocalAdsEvent(int eventType,
                                                   double lat, double lon, int accuracy);

  public static native void nativeRunFirstLaunchAnimation();

  public static native int nativeOpenRoutePointsTransaction();
  public static native void nativeApplyRoutePointsTransaction(int transactionId);
  public static native void nativeCancelRoutePointsTransaction(int transactionId);
  public static native int nativeInvalidRoutePointsTransactionId();

  public static native boolean nativeHasSavedRoutePoints();
  public static native void nativeLoadRoutePoints();
  public static native void nativeSaveRoutePoints();
  public static native void nativeDeleteSavedRoutePoints();

  public static native Banner[] nativeGetSearchBanners();

  public static native void nativeAuthenticateUser(@NonNull String socialToken,
                                                   @AuthTokenType int socialTokenType,
                                                   boolean privacyAccepted,
                                                   boolean termsAccepted,
                                                   boolean promoAccepted,
                                                   @NonNull AuthorizationListener listener);
  public static native boolean nativeIsUserAuthenticated();
  @NonNull
  public static native String nativeGetPhoneAuthUrl(@NonNull String redirectUrl);
  @NonNull
  public static native String nativeGetPrivacyPolicyLink();
  @NonNull
  public static native String nativeGetTermsOfUseLink();

  public static native void nativeShowFeatureByLatLon(double lat, double lon);
  public static native void nativeShowBookmarkCategory(long cat);

  private static native int nativeGetFilterRating(float rawRating);

  @NonNull
  public static native String nativeMoPubInitializationBannerId();

  @NonNull
  public static native DownloaderPromoBanner nativeGetDownloaderPromoBanner(@NonNull String mwmId);

  public static native boolean nativeHasMegafonCategoryBanner();

  @NonNull
  public static native String nativeGetMegafonCategoryBannerUrl();

  public static native void nativeMakeCrash();

  public static native void nativeStartPurchaseTransaction(@NonNull String serverId,
                                                           @NonNull String vendorId);
  public static native void nativeStartPurchaseTransactionListener(@Nullable
    StartTransactionListener listener);

  public static native void nativeValidatePurchase(@NonNull String serverId,
                                                   @NonNull String vendorId,
                                                   @NonNull String purchaseData);
  public static native void nativeSetPurchaseValidationListener(@Nullable
    PurchaseValidationListener listener);

  public static native boolean nativeHasActiveSubscription(@SubscriptionType int type);
  public static native void nativeSetActiveSubscription(@SubscriptionType int type,
                                                        boolean isActive);

  public static native int nativeGetCurrentTipIndex();

  private static native void nativeDisableAdProvider(int provider, int bannerPlace);

  public static native void nativeBindUser(@NonNull UserBindingListener listener);

  @Nullable
  public static native String nativeGetAccessToken();

  @Nullable
  public static native MapObject nativeGetMapObject(
      @NonNull NotificationCandidate notificationCandidate);

  public static native void nativeSetPowerManagerFacility(int facilityType, boolean state);
  public static native int nativeGetPowerManagerScheme();
  public static native void nativeSetPowerManagerScheme(int schemeType);
  public static native void nativeSetViewportCenter(double lat, double lon, int zoom,
                                                    boolean isAnim);
  public static native void nativeStopLocationFollow();

  public static native void nativeSetSearchViewport(double lat, double lon, int zoom);

  public enum LocalAdsEventType
  {
    LOCAL_ADS_EVENT_SHOW_POINT,
    LOCAL_ADS_EVENT_OPEN_INFO,
    LOCAL_ADS_EVENT_CLICKED_PHONE,
    LOCAL_ADS_EVENT_CLICKED_WEBSITE,
    LOCAL_ADS_EVENT_VISIT
  }
}