summaryrefslogtreecommitdiffstats
path: root/java/com/android/dialer/calllogutils/CallEntryFormatter.java
blob: c5ec15748e81e656ced1b0210c62acae87f06420 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/*
 * Copyright (C) 2017 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.dialer.calllogutils;

import android.content.Context;
import android.content.res.Resources;
import android.icu.lang.UCharacter;
import android.icu.text.BreakIterator;
import android.os.Build.VERSION;
import android.os.Build.VERSION_CODES;
import android.text.format.DateUtils;
import android.text.format.Formatter;
import com.android.dialer.util.DialerUtils;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Locale;
import java.util.concurrent.TimeUnit;

/** Utility class for formatting data and data usage in call log entries. */
public class CallEntryFormatter {

  /**
   * Formats the provided date into a value suitable for display in the current locale.
   *
   * <p>For example, returns a string like "Wednesday, May 25, 2016, 8:02PM" or "Chorshanba, 2016
   * may 25,20:02".
   *
   * <p>For pre-N devices, the returned value may not start with a capital if the local convention
   * is to not capitalize day names. On N+ devices, the returned value is always capitalized.
   */
  public static CharSequence formatDate(Context context, long callDateMillis) {
    CharSequence dateValue =
        DateUtils.formatDateRange(
            context,
            callDateMillis /* startDate */,
            callDateMillis /* endDate */,
            DateUtils.FORMAT_SHOW_TIME
                | DateUtils.FORMAT_SHOW_DATE
                | DateUtils.FORMAT_SHOW_WEEKDAY
                | DateUtils.FORMAT_SHOW_YEAR);

    // We want the beginning of the date string to be capitalized, even if the word at the beginning
    // of the string is not usually capitalized. For example, "Wednesdsay" in Uzbek is "chorshanba”
    // (not capitalized). To handle this issue we apply title casing to the start of the sentence so
    // that "chorshanba, 2016 may 25,20:02" becomes "Chorshanba, 2016 may 25,20:02".
    //
    // The ICU library was not available in Android until N, so we can only do this in N+ devices.
    // Pre-N devices will still see incorrect capitalization in some languages.
    if (VERSION.SDK_INT < VERSION_CODES.N) {
      return dateValue;
    }

    // Using the ICU library is safer than just applying toUpperCase() on the first letter of the
    // word because in some languages, there can be multiple starting characters which should be
    // upper-cased together. For example in Dutch "ij" is a digraph in which both letters should be
    // capitalized together.

    // TITLECASE_NO_LOWERCASE is necessary so that things that are already capitalized like the
    // month ("May") are not lower-cased as part of the conversion.
    return UCharacter.toTitleCase(
        Locale.getDefault(),
        dateValue.toString(),
        BreakIterator.getSentenceInstance(),
        UCharacter.TITLECASE_NO_LOWERCASE);
  }

  private static CharSequence formatDuration(Context context, long elapsedSeconds) {
    Resources res = context.getResources();
    String formatPattern;
    if (elapsedSeconds >= 60) {
      String minutesString = res.getString(R.string.call_details_minutes_abbreviation);
      String secondsString = res.getString(R.string.call_details_seconds_abbreviation);
      // example output: "1m 1s"
      formatPattern =
          context.getString(
              R.string.call_duration_format_pattern, "m", minutesString, "s", secondsString);
    } else {
      String secondsString = res.getString(R.string.call_details_seconds_abbreviation);
      // example output: "1s"
      formatPattern =
          context.getString(R.string.call_duration_short_format_pattern, "s", secondsString);

      // Temporary work around for a broken Hebrew(iw) translation.
      if (formatPattern.endsWith("\'\'")) {
        formatPattern = formatPattern.substring(0, formatPattern.length() - 1);
      }
    }

    // If new translation issues arise, we should catch them here to prevent crashes.
    try {
      Date date = new Date(TimeUnit.SECONDS.toMillis(elapsedSeconds));
      SimpleDateFormat format = new SimpleDateFormat(formatPattern);
      String duration = format.format(date);

      // SimpleDateFormat cannot display more than 59 minutes, instead it displays MINUTES % 60.
      // Here we check for that value and replace it with the correct value.
      if (elapsedSeconds >= TimeUnit.MINUTES.toSeconds(60)) {
        int minutes = (int) (elapsedSeconds / 60);
        duration = duration.replaceFirst(Integer.toString(minutes % 60), Integer.toString(minutes));
      }
      return duration;
    } catch (Exception e) {
      return "";
    }
  }

  private static CharSequence formatDurationA11y(Context context, long elapsedSeconds) {
    Resources res = context.getResources();
    if (elapsedSeconds >= 60) {
      int minutes = (int) (elapsedSeconds / 60);
      int seconds = (int) elapsedSeconds - minutes * 60;
      String minutesString = res.getQuantityString(R.plurals.a11y_minutes, minutes);
      String secondsString = res.getQuantityString(R.plurals.a11y_seconds, seconds);
      // example output: "1 minute 1 second", "2 minutes 2 seconds", ect.
      return context.getString(
          R.string.a11y_call_duration_format, minutes, minutesString, seconds, secondsString);
    } else {
      String secondsString = res.getQuantityString(R.plurals.a11y_seconds, (int) elapsedSeconds);
      // example output: "1 second", "2 seconds"
      return context.getString(
          R.string.a11y_call_duration_short_format, elapsedSeconds, secondsString);
    }
  }

  /**
   * Formats a string containing the call duration and the data usage (if specified).
   *
   * @param elapsedSeconds Total elapsed seconds.
   * @param dataUsage Data usage in bytes, or null if not specified.
   * @return String containing call duration and data usage.
   */
  public static CharSequence formatDurationAndDataUsage(
      Context context, long elapsedSeconds, long dataUsage) {
    return formatDurationAndDataUsageInternal(
        context, formatDuration(context, elapsedSeconds), dataUsage);
  }

  /**
   * Formats a string containing the call duration and the data usage (if specified) for TalkBack.
   *
   * @param elapsedSeconds Total elapsed seconds.
   * @param dataUsage Data usage in bytes, or null if not specified.
   * @return String containing call duration and data usage.
   */
  public static CharSequence formatDurationAndDataUsageA11y(
      Context context, long elapsedSeconds, long dataUsage) {
    return formatDurationAndDataUsageInternal(
        context, formatDurationA11y(context, elapsedSeconds), dataUsage);
  }

  private static CharSequence formatDurationAndDataUsageInternal(
      Context context, CharSequence duration, long dataUsage) {
    List<CharSequence> durationItems = new ArrayList<>();
    if (dataUsage > 0) {
      durationItems.add(duration);
      durationItems.add(Formatter.formatShortFileSize(context, dataUsage));
      return DialerUtils.join(durationItems);
    } else {
      return duration;
    }
  }
}