content: /*
   * Copyright (C) 2011 The Android Open Source Project
   *
   * 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.android.server.net;
  
  import android.net.NetworkIdentity;
  import android.service.NetworkIdentitySetProto;
  import android.util.proto.ProtoOutputStream;
  
  import java.io.DataInputStream;
  import java.io.DataOutputStream;
  import java.io.IOException;
  import java.util.HashSet;
  
  import static android.net.ConnectivityManager.TYPE_MOBILE;
  
  /**
   * Identity of a {@code iface}, defined by the set of {@link NetworkIdentity}
   * active on that interface.
   *
   * @hide
   */
  public class NetworkIdentitySet extends HashSet<NetworkIdentity> implements
          Comparable<NetworkIdentitySet> {
      private static final int VERSION_INIT = 1;
      private static final int VERSION_ADD_ROAMING = 2;
      private static final int VERSION_ADD_NETWORK_ID = 3;
      private static final int VERSION_ADD_METERED = 4;
      private static final int VERSION_ADD_DEFAULT_NETWORK = 5;
  
      public NetworkIdentitySet() {
      }
  
      public NetworkIdentitySet(DataInputStream in) throws IOException {
          final int version = in.readInt();
          final int size = in.readInt();
          for (int i = 0; i < size; i++) {
              if (version <= VERSION_INIT) {
                  final int ignored = in.readInt();
              }
              final int type = in.readInt();
              final int subType = in.readInt();
              final String subscriberId = readOptionalString(in);
              final String networkId;
              if (version >= VERSION_ADD_NETWORK_ID) {
                  networkId = readOptionalString(in);
              } else {
                  networkId = null;
              }
              final boolean roaming;
              if (version >= VERSION_ADD_ROAMING) {
                  roaming = in.readBoolean();
              } else {
                  roaming = false;
              }
  
              final boolean metered;
              if (version >= VERSION_ADD_METERED) {
                  metered = in.readBoolean();
              } else {
                  // If this is the old data and the type is mobile, treat it as metered. (Note that
                  // if this is a mobile network, TYPE_MOBILE is the only possible type that could be
                  // used.)
                  metered = (type == TYPE_MOBILE);
              }
  
              final boolean defaultNetwork;
              if (version >= VERSION_ADD_DEFAULT_NETWORK) {
                  defaultNetwork = in.readBoolean();
              } else {
                  defaultNetwork = true;
              }
  
              add(new NetworkIdentity(type, subType, subscriberId, networkId, roaming, metered,
                      defaultNetwork));
          }
      }
  
      public void writeToStream(DataOutputStream out) throws IOException {
          out.writeInt(VERSION_ADD_DEFAULT_NETWORK);
          out.writeInt(size());
          for (NetworkIdentity ident : this) {
              out.writeInt(ident.getType());
              out.writeInt(ident.getSubType());
              writeOptionalString(out, ident.getSubscriberId());
              writeOptionalString(out, ident.getNetworkId());
              out.writeBoolean(ident.getRoaming());
              out.writeBoolean(ident.getMetered());
              out.writeBoolean(ident.getDefaultNetwork());
          }
      }
  
      /** @return whether any {@link NetworkIdentity} in this set is considered metered. */
      public boolean isAnyMemberMetered() {
          if (isEmpty()) {
              return false;
          }
          for (NetworkIdentity ident : this) {
              if (ident.getMetered()) {
                  return true;
              }
          }
          return false;
      }
  
      /** @return whether any {@link NetworkIdentity} in this set is considered roaming. */
      public boolean isAnyMemberRoaming() {
          if (isEmpty()) {
              return false;
          }
          for (NetworkIdentity ident : this) {
              if (ident.getRoaming()) {
                  return true;
              }
          }
          return false;
      }
  
      /** @return whether any {@link NetworkIdentity} in this set is considered on the default
              network. */
      public boolean areAllMembersOnDefaultNetwork() {
          if (isEmpty()) {
              return true;
          }
          for (NetworkIdentity ident : this) {
              if (!ident.getDefaultNetwork()) {
                  return false;
              }
          }
          return true;
      }
  
      private static void writeOptionalString(DataOutputStream out, String value) throws IOException {
          if (value != null) {
              out.writeByte(1);
              out.writeUTF(value);
          } else {
              out.writeByte(0);
          }
      }
  
      private static String readOptionalString(DataInputStream in) throws IOException {
          if (in.readByte() != 0) {
              return in.readUTF();
          } else {
              return null;
          }
      }
  
      @Override
      public int compareTo(NetworkIdentitySet another) {
          if (isEmpty()) return -1;
          if (another.isEmpty()) return 1;
  
          final NetworkIdentity ident = iterator().next();
          final NetworkIdentity anotherIdent = another.iterator().next();
          return ident.compareTo(anotherIdent);
      }
  
      public void writeToProto(ProtoOutputStream proto, long tag) {
          final long start = proto.start(tag);
  
          for (NetworkIdentity ident : this) {
              ident.writeToProto(proto, NetworkIdentitySetProto.IDENTITIES);
          }
  
          proto.end(start);
      }
  }
  