Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2015 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | package android.os.storage; |
| 18 | |
Jeff Sharkey | d95d3bf | 2015-04-14 21:39:44 -0700 | [diff] [blame] | 19 | import android.annotation.NonNull; |
Jeff Sharkey | 4627071 | 2018-04-02 09:53:21 -0600 | [diff] [blame] | 20 | import android.annotation.Nullable; |
Mathew Inwood | 98e9ad1 | 2018-08-30 13:11:50 +0100 | [diff] [blame] | 21 | import android.annotation.UnsupportedAppUsage; |
Jeff Sharkey | 59d577a | 2015-04-11 21:27:21 -0700 | [diff] [blame] | 22 | import android.content.res.Resources; |
Mathew Inwood | 31755f9 | 2018-12-20 13:53:36 +0000 | [diff] [blame] | 23 | import android.os.Build; |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 24 | import android.os.Parcel; |
| 25 | import android.os.Parcelable; |
Jeff Sharkey | 7e92ef3 | 2015-04-17 17:35:07 -0700 | [diff] [blame] | 26 | import android.text.TextUtils; |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 27 | import android.util.DebugUtils; |
| 28 | |
| 29 | import com.android.internal.util.IndentingPrintWriter; |
| 30 | import com.android.internal.util.Preconditions; |
| 31 | |
Jeff Sharkey | 7151a9a | 2015-04-04 15:22:37 -0700 | [diff] [blame] | 32 | import java.io.CharArrayWriter; |
Jeff Sharkey | e2d45be | 2015-04-15 17:14:12 -0700 | [diff] [blame] | 33 | import java.util.Objects; |
Jeff Sharkey | 7151a9a | 2015-04-04 15:22:37 -0700 | [diff] [blame] | 34 | |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 35 | /** |
| 36 | * Information about a physical disk which may contain one or more |
| 37 | * {@link VolumeInfo}. |
| 38 | * |
| 39 | * @hide |
| 40 | */ |
| 41 | public class DiskInfo implements Parcelable { |
Jeff Sharkey | 620b32b | 2015-04-23 19:36:02 -0700 | [diff] [blame] | 42 | public static final String ACTION_DISK_SCANNED = |
| 43 | "android.os.storage.action.DISK_SCANNED"; |
| 44 | public static final String EXTRA_DISK_ID = |
| 45 | "android.os.storage.extra.DISK_ID"; |
Jeff Sharkey | c7acac6 | 2015-06-12 16:16:56 -0700 | [diff] [blame] | 46 | public static final String EXTRA_VOLUME_COUNT = |
| 47 | "android.os.storage.extra.VOLUME_COUNT"; |
Jeff Sharkey | 56bd312 | 2015-04-14 10:30:34 -0700 | [diff] [blame] | 48 | |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 49 | public static final int FLAG_ADOPTABLE = 1 << 0; |
| 50 | public static final int FLAG_DEFAULT_PRIMARY = 1 << 1; |
| 51 | public static final int FLAG_SD = 1 << 2; |
| 52 | public static final int FLAG_USB = 1 << 3; |
| 53 | |
| 54 | public final String id; |
Mathew Inwood | 98e9ad1 | 2018-08-30 13:11:50 +0100 | [diff] [blame] | 55 | @UnsupportedAppUsage |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 56 | public final int flags; |
Mathew Inwood | 98e9ad1 | 2018-08-30 13:11:50 +0100 | [diff] [blame] | 57 | @UnsupportedAppUsage |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 58 | public long size; |
Mathew Inwood | 98e9ad1 | 2018-08-30 13:11:50 +0100 | [diff] [blame] | 59 | @UnsupportedAppUsage |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 60 | public String label; |
Jeff Sharkey | f5a6bd7 | 2015-05-19 14:42:38 -0700 | [diff] [blame] | 61 | /** Hacky; don't rely on this count */ |
| 62 | public int volumeCount; |
Jeff Sharkey | e8a4b66 | 2015-06-27 15:43:45 -0700 | [diff] [blame] | 63 | public String sysPath; |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 64 | |
| 65 | public DiskInfo(String id, int flags) { |
| 66 | this.id = Preconditions.checkNotNull(id); |
| 67 | this.flags = flags; |
| 68 | } |
| 69 | |
Mathew Inwood | 31755f9 | 2018-12-20 13:53:36 +0000 | [diff] [blame] | 70 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023) |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 71 | public DiskInfo(Parcel parcel) { |
| 72 | id = parcel.readString(); |
| 73 | flags = parcel.readInt(); |
| 74 | size = parcel.readLong(); |
| 75 | label = parcel.readString(); |
Jeff Sharkey | f5a6bd7 | 2015-05-19 14:42:38 -0700 | [diff] [blame] | 76 | volumeCount = parcel.readInt(); |
Jeff Sharkey | e8a4b66 | 2015-06-27 15:43:45 -0700 | [diff] [blame] | 77 | sysPath = parcel.readString(); |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 78 | } |
| 79 | |
Mathew Inwood | 98e9ad1 | 2018-08-30 13:11:50 +0100 | [diff] [blame] | 80 | @UnsupportedAppUsage |
Jeff Sharkey | d95d3bf | 2015-04-14 21:39:44 -0700 | [diff] [blame] | 81 | public @NonNull String getId() { |
| 82 | return id; |
| 83 | } |
| 84 | |
Jeff Sharkey | e6c04f9 | 2015-04-18 21:38:05 -0700 | [diff] [blame] | 85 | private boolean isInteresting(String label) { |
| 86 | if (TextUtils.isEmpty(label)) { |
| 87 | return false; |
| 88 | } |
Jeff Sharkey | 74acbbb | 2015-04-21 12:14:03 -0700 | [diff] [blame] | 89 | if (label.equalsIgnoreCase("ata")) { |
| 90 | return false; |
| 91 | } |
Jeff Sharkey | e6c04f9 | 2015-04-18 21:38:05 -0700 | [diff] [blame] | 92 | if (label.toLowerCase().contains("generic")) { |
| 93 | return false; |
| 94 | } |
Jeff Sharkey | 47b872d | 2015-06-11 12:47:24 -0700 | [diff] [blame] | 95 | if (label.toLowerCase().startsWith("usb")) { |
| 96 | return false; |
| 97 | } |
| 98 | if (label.toLowerCase().startsWith("multiple")) { |
| 99 | return false; |
| 100 | } |
Jeff Sharkey | e6c04f9 | 2015-04-18 21:38:05 -0700 | [diff] [blame] | 101 | return true; |
| 102 | } |
| 103 | |
Mathew Inwood | 98e9ad1 | 2018-08-30 13:11:50 +0100 | [diff] [blame] | 104 | @UnsupportedAppUsage |
Jeff Sharkey | 4627071 | 2018-04-02 09:53:21 -0600 | [diff] [blame] | 105 | public @Nullable String getDescription() { |
Jeff Sharkey | 7e92ef3 | 2015-04-17 17:35:07 -0700 | [diff] [blame] | 106 | final Resources res = Resources.getSystem(); |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 107 | if ((flags & FLAG_SD) != 0) { |
Jeff Sharkey | e6c04f9 | 2015-04-18 21:38:05 -0700 | [diff] [blame] | 108 | if (isInteresting(label)) { |
Jeff Sharkey | 7e92ef3 | 2015-04-17 17:35:07 -0700 | [diff] [blame] | 109 | return res.getString(com.android.internal.R.string.storage_sd_card_label, label); |
Jeff Sharkey | e6c04f9 | 2015-04-18 21:38:05 -0700 | [diff] [blame] | 110 | } else { |
| 111 | return res.getString(com.android.internal.R.string.storage_sd_card); |
Jeff Sharkey | 7e92ef3 | 2015-04-17 17:35:07 -0700 | [diff] [blame] | 112 | } |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 113 | } else if ((flags & FLAG_USB) != 0) { |
Jeff Sharkey | e6c04f9 | 2015-04-18 21:38:05 -0700 | [diff] [blame] | 114 | if (isInteresting(label)) { |
Jeff Sharkey | 7e92ef3 | 2015-04-17 17:35:07 -0700 | [diff] [blame] | 115 | return res.getString(com.android.internal.R.string.storage_usb_drive_label, label); |
Jeff Sharkey | e6c04f9 | 2015-04-18 21:38:05 -0700 | [diff] [blame] | 116 | } else { |
| 117 | return res.getString(com.android.internal.R.string.storage_usb_drive); |
Jeff Sharkey | 7e92ef3 | 2015-04-17 17:35:07 -0700 | [diff] [blame] | 118 | } |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 119 | } else { |
| 120 | return null; |
| 121 | } |
| 122 | } |
| 123 | |
Jeff Sharkey | 4627071 | 2018-04-02 09:53:21 -0600 | [diff] [blame] | 124 | public @Nullable String getShortDescription() { |
| 125 | final Resources res = Resources.getSystem(); |
| 126 | if (isSd()) { |
| 127 | return res.getString(com.android.internal.R.string.storage_sd_card); |
| 128 | } else if (isUsb()) { |
| 129 | return res.getString(com.android.internal.R.string.storage_usb_drive); |
| 130 | } else { |
| 131 | return null; |
| 132 | } |
| 133 | } |
| 134 | |
Mathew Inwood | 98e9ad1 | 2018-08-30 13:11:50 +0100 | [diff] [blame] | 135 | @UnsupportedAppUsage |
Jeff Sharkey | 620b32b | 2015-04-23 19:36:02 -0700 | [diff] [blame] | 136 | public boolean isAdoptable() { |
| 137 | return (flags & FLAG_ADOPTABLE) != 0; |
| 138 | } |
| 139 | |
Mathew Inwood | 98e9ad1 | 2018-08-30 13:11:50 +0100 | [diff] [blame] | 140 | @UnsupportedAppUsage |
Jeff Sharkey | 620b32b | 2015-04-23 19:36:02 -0700 | [diff] [blame] | 141 | public boolean isDefaultPrimary() { |
| 142 | return (flags & FLAG_DEFAULT_PRIMARY) != 0; |
| 143 | } |
| 144 | |
Mathew Inwood | 98e9ad1 | 2018-08-30 13:11:50 +0100 | [diff] [blame] | 145 | @UnsupportedAppUsage |
Jeff Sharkey | 56bd312 | 2015-04-14 10:30:34 -0700 | [diff] [blame] | 146 | public boolean isSd() { |
| 147 | return (flags & FLAG_SD) != 0; |
| 148 | } |
| 149 | |
Mathew Inwood | 98e9ad1 | 2018-08-30 13:11:50 +0100 | [diff] [blame] | 150 | @UnsupportedAppUsage |
Jeff Sharkey | 56bd312 | 2015-04-14 10:30:34 -0700 | [diff] [blame] | 151 | public boolean isUsb() { |
| 152 | return (flags & FLAG_USB) != 0; |
| 153 | } |
| 154 | |
Jeff Sharkey | 7151a9a | 2015-04-04 15:22:37 -0700 | [diff] [blame] | 155 | @Override |
| 156 | public String toString() { |
| 157 | final CharArrayWriter writer = new CharArrayWriter(); |
| 158 | dump(new IndentingPrintWriter(writer, " ", 80)); |
| 159 | return writer.toString(); |
| 160 | } |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 161 | |
| 162 | public void dump(IndentingPrintWriter pw) { |
Jeff Sharkey | 7e92ef3 | 2015-04-17 17:35:07 -0700 | [diff] [blame] | 163 | pw.println("DiskInfo{" + id + "}:"); |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 164 | pw.increaseIndent(); |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 165 | pw.printPair("flags", DebugUtils.flagsToString(getClass(), "FLAG_", flags)); |
| 166 | pw.printPair("size", size); |
| 167 | pw.printPair("label", label); |
Jeff Sharkey | e8a4b66 | 2015-06-27 15:43:45 -0700 | [diff] [blame] | 168 | pw.println(); |
| 169 | pw.printPair("sysPath", sysPath); |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 170 | pw.decreaseIndent(); |
| 171 | pw.println(); |
| 172 | } |
| 173 | |
Jeff Sharkey | 7151a9a | 2015-04-04 15:22:37 -0700 | [diff] [blame] | 174 | @Override |
| 175 | public DiskInfo clone() { |
| 176 | final Parcel temp = Parcel.obtain(); |
| 177 | try { |
| 178 | writeToParcel(temp, 0); |
| 179 | temp.setDataPosition(0); |
| 180 | return CREATOR.createFromParcel(temp); |
| 181 | } finally { |
| 182 | temp.recycle(); |
| 183 | } |
| 184 | } |
| 185 | |
Jeff Sharkey | e2d45be | 2015-04-15 17:14:12 -0700 | [diff] [blame] | 186 | @Override |
| 187 | public boolean equals(Object o) { |
| 188 | if (o instanceof DiskInfo) { |
| 189 | return Objects.equals(id, ((DiskInfo) o).id); |
| 190 | } else { |
| 191 | return false; |
| 192 | } |
| 193 | } |
| 194 | |
| 195 | @Override |
| 196 | public int hashCode() { |
| 197 | return id.hashCode(); |
| 198 | } |
| 199 | |
Mathew Inwood | 31755f9 | 2018-12-20 13:53:36 +0000 | [diff] [blame] | 200 | @UnsupportedAppUsage(maxTargetSdk = Build.VERSION_CODES.P, trackingBug = 115609023) |
Jeff Sharkey | 9e8f83d | 2019-02-28 12:06:45 -0700 | [diff] [blame] | 201 | public static final @android.annotation.NonNull Creator<DiskInfo> CREATOR = new Creator<DiskInfo>() { |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 202 | @Override |
| 203 | public DiskInfo createFromParcel(Parcel in) { |
| 204 | return new DiskInfo(in); |
| 205 | } |
| 206 | |
| 207 | @Override |
| 208 | public DiskInfo[] newArray(int size) { |
| 209 | return new DiskInfo[size]; |
| 210 | } |
| 211 | }; |
| 212 | |
| 213 | @Override |
| 214 | public int describeContents() { |
| 215 | return 0; |
| 216 | } |
| 217 | |
| 218 | @Override |
| 219 | public void writeToParcel(Parcel parcel, int flags) { |
| 220 | parcel.writeString(id); |
Jeff Sharkey | 59d577a | 2015-04-11 21:27:21 -0700 | [diff] [blame] | 221 | parcel.writeInt(this.flags); |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 222 | parcel.writeLong(size); |
| 223 | parcel.writeString(label); |
Jeff Sharkey | f5a6bd7 | 2015-05-19 14:42:38 -0700 | [diff] [blame] | 224 | parcel.writeInt(volumeCount); |
Jeff Sharkey | e8a4b66 | 2015-06-27 15:43:45 -0700 | [diff] [blame] | 225 | parcel.writeString(sysPath); |
Jeff Sharkey | 1b8ef7e | 2015-04-03 17:14:45 -0700 | [diff] [blame] | 226 | } |
| 227 | } |