gecko/embedding/android/GeckoSmsManager.java

489 lines
16 KiB
Java
Raw Normal View History

/* -*- Mode: Java; c-basic-offset: 4; tab-width: 4; indent-tabs-mode: nil; -*-
* ***** 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 Mozilla Android code.
*
* The Initial Developer of the Original Code is Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2011
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Mounir Lamouri <mounir.lamouri@mozilla.com> (Original Author)
*
* 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;
import java.util.ArrayList;
import java.util.Iterator;
import android.util.Log;
import android.app.PendingIntent;
import android.app.Activity;
import android.content.Intent;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.ContentResolver;
import android.content.ContentValues;
import android.content.ContentUris;
import android.net.Uri;
import android.os.Bundle;
import android.telephony.SmsManager;
import android.telephony.SmsMessage;
/**
* This class is returning unique ids for PendingIntent requestCode attribute.
* There are only |Integer.MAX_VALUE - Integer.MIN_VALUE| unique IDs available,
* and they wrap around.
*/
class PendingIntentUID
{
static private int sUID = Integer.MIN_VALUE;
static public int generate() { return sUID++; }
}
/**
* The envelope class contains all information that are needed to keep track of
* a sent SMS.
*/
class Envelope
{
enum SubParts {
SENT_PART,
DELIVERED_PART
}
protected int mId;
protected int mMessageId;
protected long mMessageTimestamp;
/**
* Number of sent/delivered remaining parts.
* @note The array has much slots as SubParts items.
*/
protected int[] mRemainingParts;
/**
* Whether sending/delivering is currently failing.
* @note The array has much slots as SubParts items.
*/
protected boolean[] mFailing;
/**
* Error type (only for sent).
*/
protected int mError;
public Envelope(int aId, int aParts) {
mId = aId;
mMessageId = -1;
mMessageTimestamp = 0;
mError = GeckoSmsManager.kNoError;
int size = Envelope.SubParts.values().length;
mRemainingParts = new int[size];
mFailing = new boolean[size];
for (int i=0; i<size; ++i) {
mRemainingParts[i] = aParts;
mFailing[i] = false;
}
}
public void decreaseRemainingParts(Envelope.SubParts aType) {
--mRemainingParts[aType.ordinal()];
if (mRemainingParts[SubParts.SENT_PART.ordinal()] >
mRemainingParts[SubParts.DELIVERED_PART.ordinal()]) {
Log.e("GeckoSmsManager", "Delivered more parts than we sent!?");
}
}
public boolean arePartsRemaining(Envelope.SubParts aType) {
return mRemainingParts[aType.ordinal()] != 0;
}
public void markAsFailed(Envelope.SubParts aType) {
mFailing[aType.ordinal()] = true;
}
public boolean isFailing(Envelope.SubParts aType) {
return mFailing[aType.ordinal()];
}
public int getMessageId() {
return mMessageId;
}
public void setMessageId(int aMessageId) {
mMessageId = aMessageId;
}
public long getMessageTimestamp() {
return mMessageTimestamp;
}
public void setMessageTimestamp(long aMessageTimestamp) {
mMessageTimestamp = aMessageTimestamp;
}
public int getError() {
return mError;
}
public void setError(int aError) {
mError = aError;
}
}
/**
* Postman class is a singleton that manages Envelope instances.
*/
class Postman
{
public static final int kUnknownEnvelopeId = -1;
private static final Postman sInstance = new Postman();
private ArrayList<Envelope> mEnvelopes = new ArrayList<Envelope>(1);
private Postman() {}
public static Postman getInstance() {
return sInstance;
}
public int createEnvelope(int aParts) {
/*
* We are going to create the envelope in the first empty slot in the array
* list. If there is no empty slot, we create a new one.
*/
int size = mEnvelopes.size();
for (int i=0; i<size; ++i) {
if (mEnvelopes.get(i) == null) {
mEnvelopes.set(i, new Envelope(i, aParts));
return i;
}
}
mEnvelopes.add(new Envelope(size, aParts));
return size;
}
public Envelope getEnvelope(int aId) {
if (aId < 0 || mEnvelopes.size() <= aId) {
Log.e("GeckoSmsManager", "Trying to get an unknown Envelope!");
return null;
}
Envelope envelope = mEnvelopes.get(aId);
if (envelope == null) {
Log.e("GeckoSmsManager", "Trying to get an empty Envelope!");
}
return envelope;
}
public void destroyEnvelope(int aId) {
if (aId < 0 || mEnvelopes.size() <= aId) {
Log.e("GeckoSmsManager", "Trying to destroy an unknown Envelope!");
return;
}
if (mEnvelopes.set(aId, null) == null) {
Log.e("GeckoSmsManager", "Trying to destroy an empty Envelope!");
}
}
}
public class GeckoSmsManager
extends BroadcastReceiver
{
public final static String ACTION_SMS_RECEIVED = "android.provider.Telephony.SMS_RECEIVED";
public final static String ACTION_SMS_SENT = "org.mozilla.gecko.SMS_SENT";
public final static String ACTION_SMS_DELIVERED = "org.mozilla.gecko.SMS_DELIVERED";
private final static int kMaxMessageSize = 160;
/*
* Keep the following error codes in sync with |ErrorType| in:
* dom/sms/src/SmsRequest.h
*/
public final static int kNoError = 0;
public final static int kNoSignalError = 1;
public final static int kUnknownError = 2;
public final static int kInternalError = 3;
@Override
public void onReceive(Context context, Intent intent) {
if (intent.getAction().equals(ACTION_SMS_RECEIVED)) {
// TODO: Try to find the receiver number to be able to populate
// SmsMessage.receiver.
// TODO: Get the id and the date from the stock app saved message.
// Using the stock app saved message require us to wait for it to
// be saved which can lead to race conditions.
Bundle bundle = intent.getExtras();
if (bundle == null) {
return;
}
Object[] pdus = (Object[]) bundle.get("pdus");
for (int i=0; i<pdus.length; ++i) {
SmsMessage msg = SmsMessage.createFromPdu((byte[])pdus[i]);
GeckoAppShell.notifySmsReceived(msg.getDisplayOriginatingAddress(),
msg.getDisplayMessageBody(),
System.currentTimeMillis());
}
return;
}
if (intent.getAction().equals(ACTION_SMS_SENT) ||
intent.getAction().equals(ACTION_SMS_DELIVERED)) {
Bundle bundle = intent.getExtras();
if (bundle == null || !bundle.containsKey("envelopeId") ||
!bundle.containsKey("number") || !bundle.containsKey("message") ||
!bundle.containsKey("requestId") || !bundle.containsKey("processId")) {
Log.e("GeckoSmsManager", "Got an invalid ACTION_SMS_SENT/ACTION_SMS_DELIVERED!");
return;
}
int envelopeId = bundle.getInt("envelopeId");
Postman postman = Postman.getInstance();
Envelope envelope = postman.getEnvelope(envelopeId);
if (envelope == null) {
Log.e("GeckoSmsManager", "Got an invalid envelope id (or Envelope has been destroyed)!");
return;
}
Envelope.SubParts part = intent.getAction().equals(ACTION_SMS_SENT)
? Envelope.SubParts.SENT_PART
: Envelope.SubParts.DELIVERED_PART;
envelope.decreaseRemainingParts(part);
if (getResultCode() != Activity.RESULT_OK) {
switch (getResultCode()) {
case SmsManager.RESULT_ERROR_NULL_PDU:
envelope.setError(kInternalError);
break;
case SmsManager.RESULT_ERROR_NO_SERVICE:
case SmsManager.RESULT_ERROR_RADIO_OFF:
envelope.setError(kNoSignalError);
break;
case SmsManager.RESULT_ERROR_GENERIC_FAILURE:
default:
envelope.setError(kUnknownError);
break;
}
envelope.markAsFailed(part);
Log.i("GeckoSmsManager", "SMS part sending failed!");
}
if (envelope.arePartsRemaining(part)) {
return;
}
if (envelope.isFailing(part)) {
if (part == Envelope.SubParts.SENT_PART) {
GeckoAppShell.notifySmsSendFailed(envelope.getError(),
bundle.getInt("requestId"),
bundle.getLong("processId"));
Log.i("GeckoSmsManager", "SMS sending failed!");
} else {
// It seems unlikely to get a result code for a failure to deliver.
// Even if, we don't want to do anything with this.
Log.e("GeckoSmsManager", "SMS failed to be delivered... is that even possible?");
}
} else {
if (part == Envelope.SubParts.SENT_PART) {
String number = bundle.getString("number");
String message = bundle.getString("message");
long timestamp = System.currentTimeMillis();
int id = GeckoAppShell.saveMessageInSentbox(number, message, timestamp);
GeckoAppShell.notifySmsSent(id, number, message, timestamp,
bundle.getInt("requestId"),
bundle.getLong("processId"));
envelope.setMessageId(id);
envelope.setMessageTimestamp(timestamp);
Log.i("GeckoSmsManager", "SMS sending was successfull!");
} else {
GeckoAppShell.notifySmsDelivered(envelope.getMessageId(),
bundle.getString("number"),
bundle.getString("message"),
envelope.getMessageTimestamp());
Log.i("GeckoSmsManager", "SMS succesfully delivered!");
}
}
// Destroy the envelope object only if the SMS has been sent and delivered.
if (!envelope.arePartsRemaining(Envelope.SubParts.SENT_PART) &&
!envelope.arePartsRemaining(Envelope.SubParts.DELIVERED_PART)) {
postman.destroyEnvelope(envelopeId);
}
return;
}
}
public static int getNumberOfMessagesForText(String aText) {
return SmsManager.getDefault().divideMessage(aText).size();
}
public static void send(String aNumber, String aMessage, int aRequestId, long aProcessId) {
int envelopeId = Postman.kUnknownEnvelopeId;
try {
SmsManager sm = SmsManager.getDefault();
Intent sentIntent = new Intent(ACTION_SMS_SENT);
Intent deliveredIntent = new Intent(ACTION_SMS_DELIVERED);
Bundle bundle = new Bundle();
bundle.putString("number", aNumber);
bundle.putString("message", aMessage);
bundle.putInt("requestId", aRequestId);
bundle.putLong("processId", aProcessId);
if (aMessage.length() <= kMaxMessageSize) {
envelopeId = Postman.getInstance().createEnvelope(1);
bundle.putInt("envelopeId", envelopeId);
sentIntent.putExtras(bundle);
deliveredIntent.putExtras(bundle);
/*
* There are a few things to know about getBroadcast and pending intents:
* - the pending intents are in a shared pool maintained by the system;
* - each pending intent is identified by a token;
* - when a new pending intent is created, if it has the same token as
* another intent in the pool, one of them has to be removed.
*
* To prevent having a hard time because of this situation, we give a
* unique id to all pending intents we are creating. This unique id is
* generated by GetPendingIntentUID().
*/
PendingIntent sentPendingIntent =
PendingIntent.getBroadcast(GeckoApp.surfaceView.getContext(),
PendingIntentUID.generate(), sentIntent,
PendingIntent.FLAG_CANCEL_CURRENT);
PendingIntent deliveredPendingIntent =
PendingIntent.getBroadcast(GeckoApp.surfaceView.getContext(),
PendingIntentUID.generate(), deliveredIntent,
PendingIntent.FLAG_CANCEL_CURRENT);
sm.sendTextMessage(aNumber, "", aMessage,
sentPendingIntent, deliveredPendingIntent);
} else {
ArrayList<String> parts = sm.divideMessage(aMessage);
envelopeId = Postman.getInstance().createEnvelope(parts.size());
bundle.putInt("envelopeId", envelopeId);
sentIntent.putExtras(bundle);
deliveredIntent.putExtras(bundle);
ArrayList<PendingIntent> sentPendingIntents =
new ArrayList<PendingIntent>(parts.size());
ArrayList<PendingIntent> deliveredPendingIntents =
new ArrayList<PendingIntent>(parts.size());
for (int i=0; i<parts.size(); ++i) {
sentPendingIntents.add(
PendingIntent.getBroadcast(GeckoApp.surfaceView.getContext(),
PendingIntentUID.generate(), sentIntent,
PendingIntent.FLAG_CANCEL_CURRENT)
);
deliveredPendingIntents.add(
PendingIntent.getBroadcast(GeckoApp.surfaceView.getContext(),
PendingIntentUID.generate(), deliveredIntent,
PendingIntent.FLAG_CANCEL_CURRENT)
);
}
sm.sendMultipartTextMessage(aNumber, "", parts, sentPendingIntents,
deliveredPendingIntents);
}
} catch (Exception e) {
Log.e("GeckoSmsManager", "Failed to send an SMS: ", e);
if (envelopeId != Postman.kUnknownEnvelopeId) {
Postman.getInstance().destroyEnvelope(envelopeId);
}
GeckoAppShell.notifySmsSendFailed(kUnknownError, aRequestId, aProcessId);
}
}
public static int saveSentMessage(String aRecipient, String aBody, long aDate) {
class IdTooHighException extends Exception { }
try {
ContentValues values = new ContentValues();
values.put("address", aRecipient);
values.put("body", aBody);
values.put("date", aDate);
ContentResolver cr = GeckoApp.surfaceView.getContext().getContentResolver();
Uri uri = cr.insert(Uri.parse("content://sms/sent"), values);
long id = ContentUris.parseId(uri);
// The DOM API takes a 32bits unsigned int for the id. It's unlikely that
// we happen to need more than that but it doesn't cost to check.
if (id > Integer.MAX_VALUE) {
throw new IdTooHighException();
}
return (int)id;
} catch (IdTooHighException e) {
Log.e("GeckoSmsManager", "The id we received is higher than the higher allowed value.");
return -1;
} catch (Exception e) {
Log.e("GeckoSmsManager", "Something went wrong when trying to write a sent message: " + e);
return -1;
}
}
}