/* * Copyright (C) 2006 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.calendar; import static android.provider.Calendar.EVENT_BEGIN_TIME; import com.android.calendar.CalendarController.ViewType; import android.app.Activity; import android.content.Context; import android.content.Intent; import android.content.SharedPreferences; import android.content.res.Configuration; import android.database.Cursor; import android.database.MatrixCursor; import android.net.Uri; import android.os.Bundle; import android.text.TextUtils; import android.text.format.DateUtils; import android.text.format.Time; import android.util.CalendarUtils.TimeZoneUtils; import android.util.Log; import java.util.ArrayList; import java.util.Calendar; import java.util.Formatter; import java.util.Iterator; import java.util.List; import java.util.Map; public class Utils { private static final boolean DEBUG = true; private static final String TAG = "CalUtils"; // Set to 0 until we have UI to perform undo public static final long UNDO_DELAY = 0; // For recurring events which instances of the series are being modified public static final int MODIFY_UNINITIALIZED = 0; public static final int MODIFY_SELECTED = 1; public static final int MODIFY_ALL_FOLLOWING = 2; public static final int MODIFY_ALL = 3; // When the edit event view finishes it passes back the appropriate exit // code. public static final int DONE_REVERT = 1 << 0; public static final int DONE_SAVE = 1 << 1; public static final int DONE_DELETE = 1 << 2; // And should re run with DONE_EXIT if it should also leave the view, just // exiting is identical to reverting public static final int DONE_EXIT = 1 << 0; protected static final String OPEN_EMAIL_MARKER = " <"; protected static final String CLOSE_EMAIL_MARKER = ">"; public static final String INTENT_KEY_DETAIL_VIEW = "DETAIL_VIEW"; public static final String INTENT_KEY_VIEW_TYPE = "VIEW"; public static final String INTENT_VALUE_VIEW_TYPE_DAY = "DAY"; public static final int MONDAY_BEFORE_JULIAN_EPOCH = Time.EPOCH_JULIAN_DAY - 3; // The name of the shared preferences file. This name must be maintained for // historical // reasons, as it's what PreferenceManager assigned the first time the file // was created. private static final String SHARED_PREFS_NAME = "com.android.calendar_preferences"; private static final TimeZoneUtils mTZUtils = new TimeZoneUtils(SHARED_PREFS_NAME); private static boolean mAllowWeekForDetailView = false; private static long mTardis = 0; public static int getViewTypeFromIntentAndSharedPref(Activity activity) { Intent intent = activity.getIntent(); Bundle extras = intent.getExtras(); SharedPreferences prefs = GeneralPreferences.getSharedPreferences(activity); if (TextUtils.equals(intent.getAction(), Intent.ACTION_EDIT)) { return ViewType.EDIT; } if (extras != null) { if (extras.getBoolean(INTENT_KEY_DETAIL_VIEW, false)) { // This is the "detail" view which is either agenda or day view return prefs.getInt(GeneralPreferences.KEY_DETAILED_VIEW, GeneralPreferences.DEFAULT_DETAILED_VIEW); } else if (INTENT_VALUE_VIEW_TYPE_DAY.equals(extras.getString(INTENT_KEY_VIEW_TYPE))) { // Not sure who uses this. This logic came from LaunchActivity return ViewType.DAY; } } // Default to the last view return prefs.getInt( GeneralPreferences.KEY_START_VIEW, GeneralPreferences.DEFAULT_START_VIEW); } /** * Writes a new home time zone to the db. Updates the home time zone in the * db asynchronously and updates the local cache. Sending a time zone of * **tbd** will cause it to be set to the device's time zone. null or empty * tz will be ignored. * * @param context The calling activity * @param timeZone The time zone to set Calendar to, or **tbd** */ public static void setTimeZone(Context context, String timeZone) { mTZUtils.setTimeZone(context, timeZone); } /** * Gets the time zone that Calendar should be displayed in This is a helper * method to get the appropriate time zone for Calendar. If this is the * first time this method has been called it will initiate an asynchronous * query to verify that the data in preferences is correct. The callback * supplied will only be called if this query returns a value other than * what is stored in preferences and should cause the calling activity to * refresh anything that depends on calling this method. * * @param context The calling activity * @param callback The runnable that should execute if a query returns new * values * @return The string value representing the time zone Calendar should * display */ public static String getTimeZone(Context context, Runnable callback) { return mTZUtils.getTimeZone(context, callback); } /** * Formats a date or a time range according to the local conventions. * * @param context the context is required only if the time is shown * @param startMillis the start time in UTC milliseconds * @param endMillis the end time in UTC milliseconds * @param flags a bit mask of options See {@link DateUtils#formatDateRange(Context, Formatter, * long, long, int, String) formatDateRange} * @return a string containing the formatted date/time range. */ public static String formatDateRange( Context context, long startMillis, long endMillis, int flags) { return mTZUtils.formatDateRange(context, startMillis, endMillis, flags); } public static String getSharedPreference(Context context, String key, String defaultValue) { SharedPreferences prefs = GeneralPreferences.getSharedPreferences(context); return prefs.getString(key, defaultValue); } public static int getSharedPreference(Context context, String key, int defaultValue) { SharedPreferences prefs = GeneralPreferences.getSharedPreferences(context); return prefs.getInt(key, defaultValue); } public static boolean getSharedPreference(Context context, String key, boolean defaultValue) { SharedPreferences prefs = GeneralPreferences.getSharedPreferences(context); return prefs.getBoolean(key, defaultValue); } /** * Asynchronously sets the preference with the given key to the given value * * @param context the context to use to get preferences from * @param key the key of the preference to set * @param value the value to set */ public static void setSharedPreference(Context context, String key, String value) { SharedPreferences prefs = GeneralPreferences.getSharedPreferences(context); prefs.edit().putString(key, value).apply(); } protected static void tardis() { mTardis = System.currentTimeMillis(); } protected static long getTardis() { return mTardis; } static void setSharedPreference(Context context, String key, boolean value) { SharedPreferences prefs = GeneralPreferences.getSharedPreferences(context); SharedPreferences.Editor editor = prefs.edit(); editor.putBoolean(key, value); editor.apply(); } static void setSharedPreference(Context context, String key, int value) { SharedPreferences prefs = GeneralPreferences.getSharedPreferences(context); SharedPreferences.Editor editor = prefs.edit(); editor.putInt(key, value); editor.apply(); } /** * Save default agenda/day/week/month view for next time * * @param context * @param viewId {@link CalendarController.ViewType} */ static void setDefaultView(Context context, int viewId) { SharedPreferences prefs = GeneralPreferences.getSharedPreferences(context); SharedPreferences.Editor editor = prefs.edit(); boolean validDetailView = false; if (mAllowWeekForDetailView && viewId == CalendarController.ViewType.WEEK) { validDetailView = true; } else { validDetailView = viewId == CalendarController.ViewType.AGENDA || viewId == CalendarController.ViewType.DAY; } if (validDetailView) { // Record the detail start view editor.putInt(GeneralPreferences.KEY_DETAILED_VIEW, viewId); } // Record the (new) start view editor.putInt(GeneralPreferences.KEY_START_VIEW, viewId); editor.apply(); } public static MatrixCursor matrixCursorFromCursor(Cursor cursor) { MatrixCursor newCursor = new MatrixCursor(cursor.getColumnNames()); int numColumns = cursor.getColumnCount(); String data[] = new String[numColumns]; cursor.moveToPosition(-1); while (cursor.moveToNext()) { for (int i = 0; i < numColumns; i++) { data[i] = cursor.getString(i); } newCursor.addRow(data); } return newCursor; } /** * Compares two cursors to see if they contain the same data. * * @return Returns true of the cursors contain the same data and are not * null, false otherwise */ public static boolean compareCursors(Cursor c1, Cursor c2) { if (c1 == null || c2 == null) { return false; } int numColumns = c1.getColumnCount(); if (numColumns != c2.getColumnCount()) { return false; } if (c1.getCount() != c2.getCount()) { return false; } c1.moveToPosition(-1); c2.moveToPosition(-1); while (c1.moveToNext() && c2.moveToNext()) { for (int i = 0; i < numColumns; i++) { if (!TextUtils.equals(c1.getString(i), c2.getString(i))) { return false; } } } return true; } /** * If the given intent specifies a time (in milliseconds since the epoch), * then that time is returned. Otherwise, the current time is returned. */ public static final long timeFromIntentInMillis(Intent intent) { // If the time was specified, then use that. Otherwise, use the current // time. Uri data = intent.getData(); long millis = intent.getLongExtra(EVENT_BEGIN_TIME, -1); if (millis == -1 && data != null && data.isHierarchical()) { List path = data.getPathSegments(); if (path.size() == 2 && path.get(0).equals("time")) { try { millis = Long.valueOf(data.getLastPathSegment()); } catch (NumberFormatException e) { Log.i("Calendar", "timeFromIntentInMillis: Data existed but no valid time " + "found. Using current time."); } } } if (millis <= 0) { millis = System.currentTimeMillis(); } return millis; } /** * Formats the given Time object so that it gives the month and year (for * example, "September 2007"). * * @param time the time to format * @return the string containing the weekday and the date */ public static String formatMonthYear(Context context, Time time) { int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_NO_MONTH_DAY | DateUtils.FORMAT_SHOW_YEAR; long millis = time.toMillis(true); return formatDateRange(context, millis, millis, flags); } /** * Returns a list joined together by the provided delimiter, for example, * ["a", "b", "c"] could be joined into "a,b,c" * * @param things the things to join together * @param delim the delimiter to use * @return a string contained the things joined together */ public static String join(List things, String delim) { StringBuilder builder = new StringBuilder(); boolean first = true; for (Object thing : things) { if (first) { first = false; } else { builder.append(delim); } builder.append(thing.toString()); } return builder.toString(); } /** * Returns the week since {@link Time#EPOCH_JULIAN_DAY} (Jan 1, 1970) * adjusted for first day of week. * * This takes a julian day and the week start day and calculates which * week since {@link Time#EPOCH_JULIAN_DAY} that day occurs in, starting * at 0. *Do not* use this to compute the ISO week number for the year. * * @param julianDay The julian day to calculate the week number for * @param firstDayOfWeek Which week day is the first day of the week, * see {@link Time#SUNDAY} * @return Weeks since the epoch */ public static int getWeeksSinceEpochFromJulianDay(int julianDay, int firstDayOfWeek) { int diff = Time.THURSDAY - firstDayOfWeek; if (diff < 0) { diff += 7; } int refDay = Time.EPOCH_JULIAN_DAY - diff; return (julianDay - refDay) / 7; } /** * Takes a number of weeks since the epoch and calculates the Julian day of * the Monday for that week. * * This assumes that the week containing the {@link Time#EPOCH_JULIAN_DAY} * is considered week 0. It returns the Julian day for the Monday * {@code week} weeks after the Monday of the week containing the epoch. * * @param week Number of weeks since the epoch * @return The julian day for the Monday of the given week since the epoch */ public static int getJulianMondayFromWeeksSinceEpoch(int week) { return MONDAY_BEFORE_JULIAN_EPOCH + week * 7; } /** * Get first day of week as android.text.format.Time constant. * * @return the first day of week in android.text.format.Time */ public static int getFirstDayOfWeek(Context context) { SharedPreferences prefs = GeneralPreferences.getSharedPreferences(context); String pref = prefs.getString( GeneralPreferences.KEY_WEEK_START_DAY, GeneralPreferences.WEEK_START_DEFAULT); int startDay; if (GeneralPreferences.WEEK_START_DEFAULT.equals(pref)) { startDay = Calendar.getInstance().getFirstDayOfWeek(); } else { startDay = Integer.parseInt(pref); } if (startDay == Calendar.SATURDAY) { return Time.SATURDAY; } else if (startDay == Calendar.MONDAY) { return Time.MONDAY; } else { return Time.SUNDAY; } } /** * @return true when week number should be shown. */ public static boolean getShowWeekNumber(Context context) { final SharedPreferences prefs = GeneralPreferences.getSharedPreferences(context); return prefs.getBoolean( GeneralPreferences.KEY_SHOW_WEEK_NUM, GeneralPreferences.DEFAULT_SHOW_WEEK_NUM); } /** * @return true when declined events should be hidden. */ public static boolean getHideDeclinedEvents(Context context) { final SharedPreferences prefs = GeneralPreferences.getSharedPreferences(context); return prefs.getBoolean(GeneralPreferences.KEY_HIDE_DECLINED, false); } public static int getDaysPerWeek(Context context) { final SharedPreferences prefs = GeneralPreferences.getSharedPreferences(context); return prefs.getInt(GeneralPreferences.KEY_DAYS_PER_WEEK, 7); } /** * Determine whether the column position is Saturday or not. * * @param column the column position * @param firstDayOfWeek the first day of week in android.text.format.Time * @return true if the column is Saturday position */ public static boolean isSaturday(int column, int firstDayOfWeek) { return (firstDayOfWeek == Time.SUNDAY && column == 6) || (firstDayOfWeek == Time.MONDAY && column == 5) || (firstDayOfWeek == Time.SATURDAY && column == 0); } /** * Determine whether the column position is Sunday or not. * * @param column the column position * @param firstDayOfWeek the first day of week in android.text.format.Time * @return true if the column is Sunday position */ public static boolean isSunday(int column, int firstDayOfWeek) { return (firstDayOfWeek == Time.SUNDAY && column == 0) || (firstDayOfWeek == Time.MONDAY && column == 6) || (firstDayOfWeek == Time.SATURDAY && column == 1); } /** * Convert given UTC time into current local time. This assumes it is for an * allday event and will adjust the time to be on a midnight boundary. * * @param recycle Time object to recycle, otherwise null. * @param utcTime Time to convert, in UTC. * @param tz The time zone to convert this time to. */ public static long convertAlldayUtcToLocal(Time recycle, long utcTime, String tz) { if (recycle == null) { recycle = new Time(); } recycle.timezone = Time.TIMEZONE_UTC; recycle.set(utcTime); recycle.timezone = tz; return recycle.normalize(true); } public static long convertAlldayLocalToUTC(Time recycle, long localTime, String tz) { if (recycle == null) { recycle = new Time(); } recycle.timezone = tz; recycle.set(localTime); recycle.timezone = Time.TIMEZONE_UTC; return recycle.normalize(true); } /** * Scan through a cursor of calendars and check if names are duplicated. * This travels a cursor containing calendar display names and fills in the * provided map with whether or not each name is repeated. * * @param isDuplicateName The map to put the duplicate check results in. * @param cursor The query of calendars to check * @param nameIndex The column of the query that contains the display name */ public static void checkForDuplicateNames( Map isDuplicateName, Cursor cursor, int nameIndex) { isDuplicateName.clear(); cursor.moveToPosition(-1); while (cursor.moveToNext()) { String displayName = cursor.getString(nameIndex); // Set it to true if we've seen this name before, false otherwise if (displayName != null) { isDuplicateName.put(displayName, isDuplicateName.containsKey(displayName)); } } } /** * Null-safe object comparison * * @param s1 * @param s2 * @return */ public static boolean equals(Object o1, Object o2) { return o1 == null ? o2 == null : o1.equals(o2); } public static void setAllowWeekForDetailView(boolean allowWeekView) { mAllowWeekForDetailView = allowWeekView; } public static boolean getAllowWeekForDetailView() { return mAllowWeekForDetailView; } public static boolean isMultiPaneConfiguration (Context c) { return (c.getResources().getConfiguration().screenLayout & Configuration.SCREENLAYOUT_SIZE_XLARGE) != 0; } public static boolean getConfigBool(Context c, int key) { return c.getResources().getBoolean(key); } // Helper class for createBusyBitSegments function public static class BusyBitsSegment { public int start, end; BusyBitsSegment(int s, int e) { start = s; end = e; } @Override public int hashCode() { final int prime = 31; int result = 1; result = prime * result + end; result = prime * result + start; return result; } @Override public boolean equals(Object obj) { if (this == obj) { return true; } if (obj == null) { return false; } if (getClass() != obj.getClass()) { return false; } BusyBitsSegment other = (BusyBitsSegment) obj; if (end != other.end) { return false; } if (start != other.start) { return false; } return true; } } // Converts a list of events to a list of busy segments to draw // Assumes list is ordered according to start date public static ArrayList createBusyBitSegments(int pStart, int pEnd, int startTime, int endTime, ArrayList events) { if (events == null || events.size() == 0 || pStart >= pEnd || startTime >= endTime) return null; ArrayList segments = new ArrayList(); int start = -1; int end = -1; int timeFrame = endTime - startTime; int pSize = pEnd - pStart; // Iterate on events and create segments Iterator iter = events.iterator(); while (iter.hasNext()) { Event event = iter.next(); int eStart = event.startTime; int eEnd = event.endTime; // skip all day events, events that are not in the time frame and // events that are zero length if (event.allDay || eStart >= endTime || eEnd <= startTime || eStart == eEnd) { continue; } if (eStart < startTime) { eStart = startTime; } if (eEnd > endTime) { eEnd = endTime; } // first event , just take the values as the initial segment size if (start == -1 && end == -1) { start = eStart; end = eEnd; continue; } // combine event with current segment if (eStart <= end) { if (eEnd > end) { end = eEnd; } } else { // Push current segment to segment list and create a new segment BusyBitsSegment s = new BusyBitsSegment( (start - startTime) * pSize / timeFrame + pStart, (end - startTime) * pSize / timeFrame + pStart); segments.add(s); start = eStart; end = eEnd; } } if (start != end) { BusyBitsSegment s = new BusyBitsSegment( (start - startTime) * pSize / timeFrame + pStart, (end - startTime) * pSize / timeFrame + pStart); segments.add(s); } return segments; } }