Signal-Android/app/src/main/java/org/thoughtcrime/securesms/keyvalue/InternalValues.java

package org.thoughtcrime.securesms.keyvalue;

import androidx.annotation.NonNull;

import org.signal.ringrtc.CallManager;
import org.thoughtcrime.securesms.BuildConfig;
import org.thoughtcrime.securesms.util.Environment;
import org.thoughtcrime.securesms.util.FeatureFlags;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

public final class InternalValues extends SignalStoreValues {

  public static final String GV2_FORCE_INVITES                    = "internal.gv2.force_invites";
  public static final String GV2_IGNORE_SERVER_CHANGES            = "internal.gv2.ignore_server_changes";
  public static final String GV2_IGNORE_P2P_CHANGES               = "internal.gv2.ignore_p2p_changes";
  public static final String RECIPIENT_DETAILS                    = "internal.recipient_details";
  public static final String ALLOW_CENSORSHIP_SETTING             = "internal.force_censorship";
  public static final String FORCE_BUILT_IN_EMOJI                 = "internal.force_built_in_emoji";
  public static final String REMOVE_SENDER_KEY_MINIMUM            = "internal.remove_sender_key_minimum";
  public static final String DELAY_RESENDS                        = "internal.delay_resends";
  public static final String CALLING_SERVER                       = "internal.calling_server";
  public static final String CALLING_AUDIO_PROCESSING_METHOD      = "internal.calling_audio_processing_method";
  public static final String CALLING_BANDWIDTH_MODE               = "internal.calling_bandwidth_mode";
  public static final String CALLING_DISABLE_TELECOM              = "internal.calling_disable_telecom";
  public static final String SHAKE_TO_REPORT                      = "internal.shake_to_report";
  public static final String DISABLE_STORAGE_SERVICE              = "internal.disable_storage_service";
  public static final String FORCE_WEBSOCKET_MODE                 = "internal.force_websocket_mode";
  public static final String LAST_SCROLL_POSITION                 = "internal.last_scroll_position";

  InternalValues(KeyValueStore store) {
    super(store);
  }

  @Override
  void onFirstEverAppLaunch() {
  }

  @Override
  @NonNull List<String> getKeysToIncludeInBackup() {
    return Collections.emptyList();
  }

  /**
   * Members will not be added directly to a GV2 even if they could be.
   */
  public synchronized boolean gv2ForceInvites() {
    return FeatureFlags.internalUser() && getBoolean(GV2_FORCE_INVITES, false);
  }

  /**
   * The Server will leave out changes that can only be described by a future protocol level that
   * an older client cannot understand. Ignoring those changes by nulling them out simulates that
   * scenario for testing.
   * <p>
   * In conjunction with {@link #gv2IgnoreP2PChanges()} it means no group changes are coming into
   * the client and it will generate changes by group state comparison, and those changes will not
   * have an editor and so will be in the passive voice.
   */
  public synchronized boolean gv2IgnoreServerChanges() {
    return FeatureFlags.internalUser() && getBoolean(GV2_IGNORE_SERVER_CHANGES, false);
  }

  /**
   * Signed group changes are sent P2P, if the client ignores them, it will then ask the server
   * directly which allows testing of certain testing scenarios.
   */
  public synchronized boolean gv2IgnoreP2PChanges() {
    return FeatureFlags.internalUser() && getBoolean(GV2_IGNORE_P2P_CHANGES, false);
  }

  /**
   * Show detailed recipient info in the {@link org.thoughtcrime.securesms.components.settings.conversation.InternalConversationSettingsFragment}.
   */
  public synchronized boolean recipientDetails() {
    return FeatureFlags.internalUser() && getBoolean(RECIPIENT_DETAILS, true);
  }

  /**
   * Allow changing the censorship circumvention setting regardless of network status.
   */
  public synchronized boolean allowChangingCensorshipSetting() {
    return FeatureFlags.internalUser() && getBoolean(ALLOW_CENSORSHIP_SETTING, false);
  }

  /**
   * Force the app to use the emoji that ship with the app, as opposed to the ones that were downloaded.
   */
  public synchronized boolean forceBuiltInEmoji() {
    return FeatureFlags.internalUser() && getBoolean(FORCE_BUILT_IN_EMOJI, false);
  }

  /**
   * Remove the requirement that there must be two sender-key-capable recipients to use sender key
   */
  public synchronized boolean removeSenderKeyMinimum() {
    return FeatureFlags.internalUser() && getBoolean(REMOVE_SENDER_KEY_MINIMUM, false);
  }

  /**
   * Delay resending messages in response to retry receipts by 10 seconds.
   */
  public synchronized boolean delayResends() {
    return FeatureFlags.internalUser() && getBoolean(DELAY_RESENDS, false);
  }

  /**
   * Whether or not "shake to report" is enabled.
   */
  public synchronized boolean shakeToReport() {
    return FeatureFlags.internalUser() && getBoolean(SHAKE_TO_REPORT, true);
  }

  /**
   * Whether or not storage service is manually disabled.
   */
  public synchronized boolean storageServiceDisabled() {
    return FeatureFlags.internalUser() && getBoolean(DISABLE_STORAGE_SERVICE, false);
  }

  /**
   * The selected group calling server to use.
   * <p>
   * The user must be an internal user and the setting must be one of the current set of internal servers otherwise
   * the default SFU will be returned. This ensures that if the {@link BuildConfig#SIGNAL_SFU_INTERNAL_URLS} list changes,
   * internal users cannot be left on old servers.
   */
  public synchronized @NonNull String groupCallingServer() {
    String internalServer = FeatureFlags.internalUser() ? getString(CALLING_SERVER, Environment.Calling.defaultSfuUrl()) : null;
    if (internalServer != null && !Arrays.asList(BuildConfig.SIGNAL_SFU_INTERNAL_URLS).contains(internalServer)) {
      internalServer = null;
    }
    return internalServer != null ? internalServer : BuildConfig.SIGNAL_SFU_URL;
  }

  /**
   * Setting to override the default handling of hardware/software AEC.
   */
  public synchronized CallManager.AudioProcessingMethod callingAudioProcessingMethod() {
    if (FeatureFlags.internalUser()) {
      return CallManager.AudioProcessingMethod.values()[getInteger(CALLING_AUDIO_PROCESSING_METHOD, CallManager.AudioProcessingMethod.Default.ordinal())];
    } else {
      return CallManager.AudioProcessingMethod.Default;
    }
  }

  /**
   * Setting to override the default calling bandwidth mode.
   */
  public synchronized CallManager.BandwidthMode callingBandwidthMode() {
    if (FeatureFlags.internalUser()) {
      int                         index = getInteger(CALLING_BANDWIDTH_MODE, CallManager.BandwidthMode.NORMAL.ordinal());
      CallManager.BandwidthMode[] modes = CallManager.BandwidthMode.values();

      return index < modes.length ? modes[index] : CallManager.BandwidthMode.NORMAL;
    } else {
      return CallManager.BandwidthMode.NORMAL;
    }
  }

  /**
   * Whether or not Telecom integration is manually disabled.
   */
  public synchronized boolean callingDisableTelecom() {
    if (FeatureFlags.internalUser()) {
      return getBoolean(CALLING_DISABLE_TELECOM, true);
    } else {
      return false;
    }
  }

  /**
   * Whether or not the system is forced to be in 'websocket mode', where FCM is ignored and we use a foreground service to keep the app alive.
   */
  public boolean isWebsocketModeForced() {
    if (FeatureFlags.internalUser()) {
      return getBoolean(FORCE_WEBSOCKET_MODE, false);
    } else {
      return false;
    }
  }

  public void setLastScrollPosition(int position) {
    putInteger(LAST_SCROLL_POSITION, position);
  }

  public int getLastScrollPosition() {
    return getInteger(LAST_SCROLL_POSITION, 0);
  }
}