src/com/owncloud/android/utils/DisplayUtils.java

   1 /**
   2  *   ownCloud Android client application
   3  *
   4  *   @author Bartek Przybylski
   5  *   @author David A. Velasco
   6  *   Copyright (C) 2011  Bartek Przybylski
   7  *   Copyright (C) 2015 ownCloud Inc.
   8  *
   9  *   This program is free software: you can redistribute it and/or modify
  10  *   it under the terms of the GNU General Public License version 2,
  11  *   as published by the Free Software Foundation.
  12  *
  13  *   This program is distributed in the hope that it will be useful,
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *   GNU General Public License for more details.
  17  *
  18  *   You should have received a copy of the GNU General Public License
  19  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  *
  21  */
  22
  23 package com.owncloud.android.utils;
  24
  25 import java.io.File;
  26 import java.net.IDN;
  27 import java.text.DateFormat;
  28 import java.util.Arrays;
  29 import java.util.Calendar;
  30 import java.util.Date;
  31 import java.util.HashMap;
  32 import java.util.HashSet;
  33 import java.util.Set;
  34 import java.util.Vector;
  35
  36 import android.annotation.TargetApi;
  37 import android.app.Activity;
  38 import android.content.Context;
  39 import android.content.SharedPreferences;
  40 import android.graphics.Point;
  41 import android.graphics.PorterDuff;
  42 import android.os.Build;
  43 import android.text.format.DateUtils;
  44 import android.view.Display;
  45 import android.widget.ProgressBar;
  46 import android.widget.SeekBar;
  47
  48 import com.owncloud.android.MainApp;
  49 import com.owncloud.android.R;
  50 import com.owncloud.android.datamodel.FileDataStorageManager;
  51 import com.owncloud.android.datamodel.OCFile;
  52
  53 import java.math.BigDecimal;
  54 import java.net.IDN;
  55 import java.text.DateFormat;
  56 import java.util.Calendar;
  57 import java.util.Date;
  58 import java.util.HashMap;
  59 import java.util.Map;
  60
  61 /**
  62  * A helper class for some string operations.
  63  */
  64 public class DisplayUtils {
  65
  66     private static final String OWNCLOUD_APP_NAME = "ownCloud";
  67
  68     private static final String[] sizeSuffixes = { "B", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB" };
  69     private static final int[] sizeScales = { 0, 0, 0, 1, 1, 2, 2, 2, 2 };
  70
  71     private static Map<String, String> mimeType2HumanReadable;
  72
  73     static {
  74         mimeType2HumanReadable = new HashMap<String, String>();
  75         // images
  76         mimeType2HumanReadable.put("image/jpeg", "JPEG image");
  77         mimeType2HumanReadable.put("image/jpg", "JPEG image");
  78         mimeType2HumanReadable.put("image/png", "PNG image");
  79         mimeType2HumanReadable.put("image/bmp", "Bitmap image");
  80         mimeType2HumanReadable.put("image/gif", "GIF image");
  81         mimeType2HumanReadable.put("image/svg+xml", "JPEG image");
  82         mimeType2HumanReadable.put("image/tiff", "TIFF image");
  83         // music
  84         mimeType2HumanReadable.put("audio/mpeg", "MP3 music file");
  85         mimeType2HumanReadable.put("application/ogg", "OGG music file");
  86     }
  87
  88     /**
  89      * Converts the file size in bytes to human readable output.
  90      * <ul>
  91      *     <li>appends a size suffix, e.g. B, KB, MB etc.</li>
  92      *     <li>rounds the size based on the suffix to 0,1 or 2 decimals</li>
  93      * </ul>
  94      *
  95      * @param bytes Input file size
  96      * @return Like something readable like "12 MB"
  97      */
  98     public static String bytesToHumanReadable(long bytes) {
  99         double result = bytes;
 100         int attachedSuff = 0;
 101         while (result > 1024 && attachedSuff < sizeSuffixes.length) {
 102             result /= 1024.;
 103             attachedSuff++;
 104         }
 105
 106         return new BigDecimal(result).setScale(
 107                 sizeScales[attachedSuff], BigDecimal.ROUND_HALF_UP) + " " + sizeSuffixes[attachedSuff];
 108     }
 109
 110     /**
 111      * Converts MIME types like "image/jpg" to more end user friendly output
 112      * like "JPG image".
 113      *
 114      * @param mimetype MIME type to convert
 115      * @return A human friendly version of the MIME type
 116      */
 117     public static String convertMIMEtoPrettyPrint(String mimetype) {
 118         if (mimeType2HumanReadable.containsKey(mimetype)) {
 119             return mimeType2HumanReadable.get(mimetype);
 120         }
 121         if (mimetype.split("/").length >= 2)
 122             return mimetype.split("/")[1].toUpperCase() + " file";
 123         return "Unknown type";
 124     }
 125
 126     /**
 127      * Converts Unix time to human readable format
 128      * @param milliseconds that have passed since 01/01/1970
 129      * @return The human readable time for the users locale
 130      */
 131     public static String unixTimeToHumanReadable(long milliseconds) {
 132         Date date = new Date(milliseconds);
 133         DateFormat df = DateFormat.getDateTimeInstance();
 134         return df.format(date);
 135     }
 136
 137     public static int getSeasonalIconId() {
 138         if (Calendar.getInstance().get(Calendar.DAY_OF_YEAR) >= 354 &&
 139                 MainApp.getAppContext().getString(R.string.app_name).equals(OWNCLOUD_APP_NAME)) {
 140             return R.drawable.winter_holidays_icon;
 141         } else {
 142             return R.drawable.icon;
 143         }
 144     }
 145
 146     /**
 147      * Converts an internationalized domain name (IDN) in an URL to and from ASCII/Unicode.
 148      * @param url the URL where the domain name should be converted
 149      * @param toASCII if true converts from Unicode to ASCII, if false converts from ASCII to Unicode
 150      * @return the URL containing the converted domain name
 151      */
 152     @TargetApi(Build.VERSION_CODES.GINGERBREAD)
 153     public static String convertIdn(String url, boolean toASCII) {
 154
 155         String urlNoDots = url;
 156         String dots="";
 157         while (urlNoDots.startsWith(".")) {
 158             urlNoDots = url.substring(1);
 159             dots = dots + ".";
 160         }
 161
 162         if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.GINGERBREAD) {
 163             // Find host name after '//' or '@'
 164             int hostStart = 0;
 165             if  (urlNoDots.indexOf("//") != -1) {
 166                 hostStart = url.indexOf("//") + "//".length();
 167             } else if (url.indexOf("@") != -1) {
 168                 hostStart = url.indexOf("@") + "@".length();
 169             }
 170
 171             int hostEnd = url.substring(hostStart).indexOf("/");
 172             // Handle URL which doesn't have a path (path is implicitly '/')
 173             hostEnd = (hostEnd == -1 ? urlNoDots.length() : hostStart + hostEnd);
 174
 175             String host = urlNoDots.substring(hostStart, hostEnd);
 176             host = (toASCII ? IDN.toASCII(host) : IDN.toUnicode(host));
 177
 178             return dots + urlNoDots.substring(0, hostStart) + host + urlNoDots.substring(hostEnd);
 179         } else {
 180             return dots + url;
 181         }
 182     }
 183
 184     /**
 185      * Get the file extension if it is on path as type "content://.../DocInfo.doc"
 186      * @param filepath: Content Uri converted to string format
 187      * @return String: fileExtension (type '.pdf'). Empty if no extension
 188      */
 189     public static String getComposedFileExtension(String filepath) {
 190         String fileExtension = "";
 191         String fileNameInContentUri = filepath.substring(filepath.lastIndexOf("/"));
 192
 193         // Check if extension is included in uri
 194         int pos = fileNameInContentUri.lastIndexOf('.');
 195         if (pos >= 0) {
 196             fileExtension = fileNameInContentUri.substring(pos);
 197         }
 198         return fileExtension;
 199     }
 200
 201     public static CharSequence getRelativeTimestamp(Context context, OCFile file) {
 202         return getRelativeDateTimeString(context, file.getModificationTimestamp(),
 203                 DateUtils.SECOND_IN_MILLIS, DateUtils.WEEK_IN_MILLIS, 0);
 204     }
 205
 206     @SuppressWarnings("deprecation")
 207     private static CharSequence getRelativeDateTimeString (
 208             Context c, long time, long minResolution, long transitionResolution, int flags
 209             ){
 210
 211         CharSequence dateString = "";
 212
 213         // in Future
 214         if (time > System.currentTimeMillis()){
 215             return DisplayUtils.unixTimeToHumanReadable(time);
 216         }
 217         // < 60 seconds -> seconds ago
 218         else if ((System.currentTimeMillis() - time) < 60 * 1000) {
 219             return c.getString(R.string.file_list_seconds_ago);
 220         } else {
 221             dateString = DateUtils.getRelativeDateTimeString(c, time, minResolution, transitionResolution, flags);
 222         }
 223
 224         String[] parts = dateString.toString().split(",");
 225         if (parts.length == 2) {
 226             if (parts[1].contains(":") && !parts[0].contains(":")) {
 227                 return parts[0];
 228             } else if (parts[0].contains(":") && !parts[1].contains(":")) {
 229                 return parts[1];
 230             }
 231         }
 232         //dateString contains unexpected format. fallback: use relative date time string from android api as is.
 233         return dateString.toString();
 234     }
 235
 236     /**
 237      * Update the passed path removing the last "/" if it is not the root folder
 238      * @param path
 239      */
 240     public static String getPathWithoutLastSlash(String path) {
 241
 242         // Remove last slash from path
 243         if (path.length() > 1 && path.charAt(path.length()-1) == OCFile.PATH_SEPARATOR.charAt(0)) {
 244             path = path.substring(0, path.length()-1);
 245         }
 246         return path;
 247     }
 248
 249
 250     /**
 251      * Gets the screen size in pixels in a backwards compatible way
 252      *
 253      * @param caller        Activity calling; needed to get access to the {@link android.view.WindowManager}
 254      * @return              Size in pixels of the screen, or default {@link Point} if caller is null
 255      */
 256     public static Point getScreenSize(Activity caller) {
 257         Point size = new Point();
 258         if (caller != null) {
 259             Display display = caller.getWindowManager().getDefaultDisplay();
 260             if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.HONEYCOMB_MR2) {
 261                 display.getSize(size);
 262             } else {
 263                 size.set(display.getWidth(), display.getHeight());
 264             }
 265         }
 266         return size;
 267     }
 268
 269     /**
 270      * Determines if user set folder to grid or list view. If folder is not set itself,
 271      * it finds a parent that is set (at least root is set).
 272      * @param file
 273      * @param storageManager
 274      * @return
 275      */
 276     public static boolean isGridView(OCFile file, FileDataStorageManager storageManager){
 277         if (file != null) {
 278             OCFile fileToTest = file;
 279             OCFile parentDir = null;
 280             String parentPath = null;
 281
 282             SharedPreferences setting = MainApp.getAppContext().getSharedPreferences(
 283                     "viewMode", Context.MODE_PRIVATE);
 284
 285             if (setting.contains(fileToTest.getRemoteId())) {
 286                 return setting.getBoolean(fileToTest.getRemoteId(), false);
 287             } else {
 288                 do {
 289                     if (fileToTest.getParentId() != FileDataStorageManager.ROOT_PARENT_ID) {
 290                         parentPath = new File(fileToTest.getRemotePath()).getParent();
 291                         parentPath = parentPath.endsWith(OCFile.PATH_SEPARATOR) ? parentPath :
 292                                 parentPath + OCFile.PATH_SEPARATOR;
 293                         parentDir = storageManager.getFileByPath(parentPath);
 294                     } else {
 295                         parentDir = storageManager.getFileByPath(OCFile.ROOT_PATH);
 296                     }
 297
 298                     while (parentDir == null) {
 299                         parentPath = new File(parentPath).getParent();
 300                         parentPath = parentPath.endsWith(OCFile.PATH_SEPARATOR) ? parentPath :
 301                                 parentPath + OCFile.PATH_SEPARATOR;
 302                         parentDir = storageManager.getFileByPath(parentPath);
 303                     }
 304                     fileToTest = parentDir;
 305                 } while (endWhile(parentDir, setting));
 306                 return setting.getBoolean(fileToTest.getRemoteId(), false);
 307             }
 308         } else {
 309             return false;
 310         }
 311     }
 312
 313     private static boolean endWhile(OCFile parentDir, SharedPreferences setting) {
 314         if (parentDir.getRemotePath().compareToIgnoreCase(OCFile.ROOT_PATH) == 0) {
 315             return false;
 316         } else {
 317             return !setting.contains(parentDir.getRemoteId());
 318         }
 319     }
 320
 321     public static void setViewMode(OCFile file, boolean setGrid){
 322         SharedPreferences setting = MainApp.getAppContext().getSharedPreferences(
 323                 "viewMode", Context.MODE_PRIVATE);
 324
 325         SharedPreferences.Editor editor = setting.edit();
 326         editor.putBoolean(file.getRemoteId(), setGrid);
 327         editor.commit();
 328     }
 329
 330     /**
 331      * sets the coloring of the given progress bar to color_accent.
 332      *
 333      * @param progressBar the progress bar to be colored
 334      */
 335     public static void colorPreLollipopHorizontalProgressBar(ProgressBar progressBar) {
 336         if (progressBar != null && Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) {
 337             int color = progressBar.getResources().getColor(R.color.color_accent);
 338             progressBar.getIndeterminateDrawable().setColorFilter(color, PorterDuff.Mode.SRC_IN);
 339             progressBar.getProgressDrawable().setColorFilter(color, PorterDuff.Mode.SRC_IN);
 340         }
 341     }
 342
 343     /**
 344      * sets the coloring of the given seek bar to color_accent.
 345      *
 346      * @param seekBar the seek bar to be colored
 347      */
 348     public static void colorPreLollipopHorizontalSeekBar(SeekBar seekBar) {
 349         if (seekBar != null && Build.VERSION.SDK_INT < Build.VERSION_CODES.LOLLIPOP) {
 350             colorPreLollipopHorizontalProgressBar(seekBar);
 351
 352             if(Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN) {
 353                 int color = seekBar.getResources().getColor(R.color.color_accent);
 354                 seekBar.getThumb().setColorFilter(color, PorterDuff.Mode.SRC_IN);
 355                 seekBar.getThumb().setColorFilter(color, PorterDuff.Mode.SRC_IN);
 356             }
 357         }
 358     }
 359 }