gecko/mobile/android/base/sync/Utils.java

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Android Sync Client.
 *
 * The Initial Developer of the Original Code is
 * the Mozilla Foundation.
 * Portions created by the Initial Developer are Copyright (C) 2011
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * Jason Voll <jvoll@mozilla.com>
 * Richard Newman <rnewman@mozilla.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

package org.mozilla.gecko.sync;

import java.io.UnsupportedEncodingException;
import java.math.BigDecimal;
import java.security.NoSuchAlgorithmException;
import java.util.HashMap;
import java.util.Random;

import org.mozilla.apache.commons.codec.binary.Base32;
import org.mozilla.apache.commons.codec.binary.Base64;
import org.mozilla.gecko.sync.crypto.Cryptographer;

import android.content.Context;
import android.content.SharedPreferences;
import android.util.Log;

public class Utils {

  private static final String LOG_TAG = "Utils";

  // See <http://developer.android.com/reference/android/content/Context.html#getSharedPreferences%28java.lang.String,%20int%29>
  public static final int SHARED_PREFERENCES_MODE = 0;


  // We don't really have a trace logger, so use this to toggle
  // some debug logging.
  // This is awful. I'm so sorry.
  public static boolean ENABLE_TRACE_LOGGING = true;

  // If true, log to System.out as well as using Android's Log.* calls.
  public static boolean LOG_TO_STDOUT = false;
  public static void logToStdout(String... s) {
    if (LOG_TO_STDOUT) {
      for (String string : s) {
        System.out.print(string);
      }
      System.out.println("");
    }
  }

  public static void error(String logTag, String message) {
    logToStdout(logTag, " :: ERROR: ", message);
    Log.i(logTag, message);
  }

  public static void info(String logTag, String message) {
    logToStdout(logTag, " :: INFO: ", message);
    Log.i(logTag, message);
  }

  public static void debug(String logTag, String message) {
    logToStdout(logTag, " :: DEBUG: ", message);
    Log.d(logTag, message);
  }

  public static void trace(String logTag, String message) {
    if (!ENABLE_TRACE_LOGGING) {
      return;
    }
    logToStdout(logTag, " :: TRACE: ", message);
    Log.d(logTag, message);
  }

  public static String generateGuid() {
    byte[] encodedBytes = Base64.encodeBase64(generateRandomBytes(9), false);
    return new String(encodedBytes).replace("+", "-").replace("/", "_");
  }

  private static byte[] generateRandomBytes(int length) {
    byte[] bytes = new byte[length];
    Random random = new Random(System.nanoTime());
    random.nextBytes(bytes);
    return bytes;
  }

  /*
   * Helper to convert Byte Array to a Hex String
   * Input: byte[] array
   * Output: Hex string
   */
  public static String byte2hex(byte[] b) {
  
      // String Buffer can be used instead
      String hs = "";
      String stmp = "";
  
      for (int n = 0; n < b.length; n++) {
          stmp = (java.lang.Integer.toHexString(b[n] & 0XFF));
  
          if (stmp.length() == 1) {
              hs = hs + "0" + stmp;
          } else {
              hs = hs + stmp;
          }
  
          if (n < b.length - 1) {
              hs = hs + "";
          }
      }
  
      return hs;
  }

  /*
   * Helper for array concatenation.
   * Input: At least two byte[]
   * Output: A concatenated version of them
   */
  public static byte[] concatAll(byte[] first, byte[]... rest) {
      int totalLength = first.length;
      for (byte[] array : rest) {
          totalLength += array.length;
      }
  
      byte[] result = new byte[totalLength];
      int offset = first.length;

      System.arraycopy(first, 0, result, 0, offset);
  
      for (byte[] array : rest) {
          System.arraycopy(array, 0, result, offset, array.length);
          offset += array.length;
      }
      return result;
  }

  /**
   * Utility for Base64 decoding. Should ensure that the correct
   * Apache Commons version is used.
   *
   * @param base64
   *        An input string. Will be decoded as UTF-8.
   * @return
   *        A byte array of decoded values.
   * @throws UnsupportedEncodingException
   *         Should not occur.
   */
  public static byte[] decodeBase64(String base64) throws UnsupportedEncodingException {
      return Base64.decodeBase64(base64.getBytes("UTF-8"));
  }

  /*
   * Decode a friendly base32 string.
   */
  public static byte[] decodeFriendlyBase32(String base32) {
      Base32 converter = new Base32();
      return converter.decode(base32.replace('8', 'l').replace('9', 'o')
              .toUpperCase());
  }

  /*
   * Helper to convert Hex String to Byte Array
   * Input: Hex string
   * Output: byte[] version of hex string
   */
  public static byte[] hex2Byte(String str)
  {
      if (str.length() % 2 == 1) {
          str = "0" + str;
      }
  
      byte[] bytes = new byte[str.length() / 2];
      for (int i = 0; i < bytes.length; i++)
      {
          bytes[i] = (byte) Integer
              .parseInt(str.substring(2 * i, 2 * i + 2), 16);
      }
      return bytes;
  }

  public static String millisecondsToDecimalSecondsString(long ms) {
    return new BigDecimal(ms).movePointLeft(3).toString();
  }

  // This lives until Bug 708956 lands, and we don't have to do it any more.
  public static long decimalSecondsToMilliseconds(String decimal) {
    try {
      return new BigDecimal(decimal).movePointRight(3).longValue();
    } catch (Exception e) {
      return -1;
    }
  }

  // Oh, Java.
  public static long decimalSecondsToMilliseconds(Double decimal) {
    // Truncates towards 0.
    return (long)(decimal * 1000);
  }
  public static long decimalSecondsToMilliseconds(Long decimal) {
    return decimal * 1000;
  }
  public static long decimalSecondsToMilliseconds(Integer decimal) {
    return (long)(decimal * 1000);
  }


  public static String getPrefsPath(String username, String serverURL)
    throws NoSuchAlgorithmException, UnsupportedEncodingException {
    return "sync.prefs." + Cryptographer.sha1Base32(serverURL + ":" + username);
  }

  public static SharedPreferences getSharedPreferences(Context context, String username, String serverURL) throws NoSuchAlgorithmException, UnsupportedEncodingException {
    String prefsPath = getPrefsPath(username, serverURL);
    Log.d(LOG_TAG, "Shared preferences: " + prefsPath);
    return context.getSharedPreferences(prefsPath, SHARED_PREFERENCES_MODE);
  }

  /**
   * Populate null slots in the provided array from keys in the provided Map.
   * Set values in the map to be the new indices.
   *
   * @param dest
   * @param source
   * @throws Exception
   */
  public static void fillArraySpaces(String[] dest, HashMap<String, Long> source) throws Exception {
    int i = 0;
    int c = dest.length;
    int needed = source.size();
    if (needed == 0) {
      return;
    }
    if (needed > c) {
      throw new Exception("Need " + needed + " array spaces, have no more than " + c);
    }
    for (String key : source.keySet()) {
      while (i < c) {
        if (dest[i] == null) {
          // Great!
          dest[i] = key;
          source.put(key, (long) i);
          break;
        }
        ++i;
      }
    }
    if (i >= c) {
      throw new Exception("Could not fill array spaces.");
    }
  }
}