Merge pull request #5 from NetMatch/master (dd4ca03e) · Commits · codevise / cordova-plugin-adm

README.md

+12 −13

Changes for README.md: 12 added lines, 13 removed lines.
Original line number	Diff line number	Diff line
		@@ -36,21 +36,20 @@ This plugin is for use with [Cordova](http://incubator.apache.org/cordova/), and
		## Manual Installation for Android


		1) copy the contents of src/android/com/ to your project's src/com/ folder. The final hirearchy will likely look something like this;
		1) copy the contents of src/android/com/ to your project's src/com/ folder.
		copy the contents of libs/ to your libs/ folder.
		The final hirearchy will likely look something like this;

		{project_folder}
		libs
		gcm.jar
		src
		com
		google
		android
		plugin
		gcm
		GCMBaseIntentService.java
		GCMBroadcastReceiver.java
		GCMConstants.java
		CordovaGCMBroadcastReceiver.java
		GCMIntentService.java
		GCMRegistrar.java
		plugin
		GCM
		PushHandlerActivity.java
		PushPlugin.java
		{company_name}
		{intent_name}
		@@ -70,19 +69,19 @@ This plugin is for use with [Cordova](http://incubator.apache.org/cordova/), and

		3) Modify your AndroidManifest.xml and add the following activity, receiver and service tags to your application section, replacing your_app_package with your app's package path: (See the Sample_AndroidManifest.xml file in the Example folder.)

		<activity android:name="com.plugin.GCM.PushHandlerActivity"/>
		<receiver android:name="com.google.android.gcm.GCMBroadcastReceiver" android:permission="com.google.android.c2dm.permission.SEND" >
		<activity android:name="com.plugin.gcm.PushHandlerActivity"/>
		<receiver android:name="com.plugin.gcm.CordovaGCMBroadcastReceiver" android:permission="com.google.android.c2dm.permission.SEND" >
		<intent-filter>
		<action android:name="com.google.android.c2dm.intent.RECEIVE" />
		<action android:name="com.google.android.c2dm.intent.REGISTRATION" />
		<category android:name="your_app_package" />
		</intent-filter>
		</receiver>
		<service android:name="com.google.android.gcm.GCMIntentService" />
		<service android:name="com.plugin.gcm.GCMIntentService" />

		4) Modify your res/xml/config.xml to include the following line in order to tell Cordova to include this plugin and where it can be found: (See the Sample_config.xml file in the Example folder)

		<plugin name="PushPlugin" value="com.plugin.GCM.PushPlugin" />
		<plugin name="PushPlugin" value="com.plugin.gcm.PushPlugin" />

		5) Add the PushNotification.js script to your assets/www folder (or javascripts folder, wherever you want really) and reference it in your main index.html file. This file's usage is described in the Plugin API section below.

plugin.xml

+10 −11

Changes for plugin.xml: 10 added lines, 11 removed lines.
Original line number	Diff line number	Diff line
		@@ -14,7 +14,7 @@

		<platform name="android">
		<config-file target="res/xml/config.xml" parent="plugins">
		<plugin name="PushPlugin" value="com.plugin.GCM.PushPlugin" />
		<plugin name="PushPlugin" value="com.plugin.gcm.PushPlugin" />
		</config-file>

		<config-file target="AndroidManifest.xml" parent="/manifest">
		@@ -28,25 +28,24 @@
		</config-file>

		<config-file target="AndroidManifest.xml" parent="/manifest/application">
		<activity android:name="com.plugin.GCM.PushHandlerActivity"/>
		<receiver android:name="com.google.android.gcm.GCMBroadcastReceiver" android:permission="com.google.android.c2dm.permission.SEND" >
		<activity android:name="com.plugin.gcm.PushHandlerActivity"/>
		<receiver android:name="com.plugin.gcm.CordovaGCMBroadcastReceiver" android:permission="com.google.android.c2dm.permission.SEND" >
		<intent-filter>
		<action android:name="com.google.android.c2dm.intent.RECEIVE" />
		<action android:name="com.google.android.c2dm.intent.REGISTRATION" />
		<category android:name="$PACKAGE_NAME" />
		</intent-filter>
		</receiver>
		<service android:name="com.google.android.gcm.GCMIntentService" />
		<service android:name="com.plugin.gcm.GCMIntentService" />
		</config-file>

		<source-file src="src/android/com/google/android/gcm/GCMBaseIntentService.java" target-dir="src/com/google/android/gcm/" />
		<source-file src="src/android/com/google/android/gcm/GCMBroadcastReceiver.java" target-dir="src/com/google/android/gcm/" />
		<source-file src="src/android/com/google/android/gcm/GCMConstants.java" target-dir="src/com/google/android/gcm/" />
		<source-file src="src/android/com/google/android/gcm/GCMRegistrar.java" target-dir="src/com/google/android/gcm/" />
		<source-file src="src/android/com/google/android/gcm/GCMIntentService.java" target-dir="src/com/google/android/gcm/" />
		<source-file src="src/android/com/plugin/GCM/PushPlugin.java" target-dir="src/com/plugin/GCM/" />
		<source-file src="src/android/com/plugin/GCM/PushHandlerActivity.java" target-dir="src/com/plugin/GCM/" />
		<source-file src="src/android/libs/gcm.jar" target-dir="libs/" />
		<source-file src="src/android/com/plugin/gcm/CordovaGCMBroadcastReceiver.java" target-dir="src/com/plugin/gcm/" />
		<source-file src="src/android/com/plugin/gcm/GCMIntentService.java" target-dir="src/com/plugin/gcm/" />
		<source-file src="src/android/com/plugin/gcm/PushHandlerActivity.java" target-dir="src/com/plugin/gcm/" />
		<source-file src="src/android/com/plugin/gcm/PushPlugin.java" target-dir="src/com/plugin/gcm/" />
		<source-file src="src/android/com/plugin/android-support-v13.jar" target-dir="libs/" />

		</platform>

		<!-- ios -->

src/android/com/google/android/gcm/GCMBaseIntentService.java

deleted100644 → 0

+0 −299

Changes for src/android/com/google/android/gcm/GCMBaseIntentService.java: 0 added lines, 299 removed lines.
Original line number	Diff line number	Diff line
		/*
		* Copyright 2012 Google Inc.
		*
		* 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.google.android.gcm;

		import static com.google.android.gcm.GCMConstants.ERROR_SERVICE_NOT_AVAILABLE;
		import static com.google.android.gcm.GCMConstants.EXTRA_ERROR;
		import static com.google.android.gcm.GCMConstants.EXTRA_REGISTRATION_ID;
		import static com.google.android.gcm.GCMConstants.EXTRA_SPECIAL_MESSAGE;
		import static com.google.android.gcm.GCMConstants.EXTRA_TOTAL_DELETED;
		import static com.google.android.gcm.GCMConstants.EXTRA_UNREGISTERED;
		import static com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_LIBRARY_RETRY;
		import static com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_MESSAGE;
		import static com.google.android.gcm.GCMConstants.INTENT_FROM_GCM_REGISTRATION_CALLBACK;
		import static com.google.android.gcm.GCMConstants.VALUE_DELETED_MESSAGES;

		import android.app.AlarmManager;
		import android.app.IntentService;
		import android.app.PendingIntent;
		import android.content.Context;
		import android.content.Intent;
		import android.os.PowerManager;
		import android.os.SystemClock;
		import android.util.Log;

		import java.util.Random;
		import java.util.concurrent.TimeUnit;

		/**
		* Skeleton for application-specific {@link IntentService}s responsible for
		* handling communication from Google Cloud Messaging service.
		* <p>
		* The abstract methods in this class are called from its worker thread, and
		* hence should run in a limited amount of time. If they execute long
		* operations, they should spawn new threads, otherwise the worker thread will
		* be blocked.
		*/
		public abstract class GCMBaseIntentService extends IntentService {

		public static final String TAG = "GCMBaseIntentService";

		// wakelock
		private static final String WAKELOCK_KEY = "GCM_LIB";
		private static PowerManager.WakeLock sWakeLock;

		// Java lock used to synchronize access to sWakelock
		private static final Object LOCK = GCMBaseIntentService.class;

		private final String mSenderId;

		// instance counter
		private static int sCounter = 0;

		private static final Random sRandom = new Random();

		private static final int MAX_BACKOFF_MS =
		(int) TimeUnit.SECONDS.toMillis(3600); // 1 hour

		// token used to check intent origin
		private static final String TOKEN =
		Long.toBinaryString(sRandom.nextLong());
		private static final String EXTRA_TOKEN = "token";

		/**
		* Subclasses must create a public no-arg constructor and pass the
		* sender id to be used for registration.
		*/
		protected GCMBaseIntentService(String senderId) {
		// name is used as base name for threads, etc.
		super("GCMIntentService-" + senderId + "-" + (++sCounter));
		mSenderId = senderId;
		}

		/**
		* Called when a cloud message has been received.
		*
		* @param context application's context.
		* @param intent intent containing the message payload as extras.
		*/
		protected abstract void onMessage(Context context, Intent intent);

		/**
		* Called when the GCM server tells pending messages have been deleted
		* because the device was idle.
		*
		* @param context application's context.
		* @param total total number of collapsed messages
		*/
		protected void onDeletedMessages(Context context, int total) {
		}

		/**
		* Called on a registration error that could be retried.
		*
		* <p>By default, it does nothing and returns {@literal true}, but could be
		* overridden to change that behavior and/or display the error.
		*
		* @param context application's context.
		* @param errorId error id returned by the GCM service.
		*
		* @return if {@literal true}, failed operation will be retried (using
		* exponential backoff).
		*/
		protected boolean onRecoverableError(Context context, String errorId) {
		return true;
		}

		/**
		* Called on registration or unregistration error.
		*
		* @param context application's context.
		* @param errorId error id returned by the GCM service.
		*/
		protected abstract void onError(Context context, String errorId);

		/**
		* Called after a device has been registered.
		*
		* @param context application's context.
		* @param registrationId the registration id returned by the GCM service.
		*/
		protected abstract void onRegistered(Context context,
		String registrationId);

		/**
		* Called after a device has been unregistered.
		*
		* @param registrationId the registration id that was previously registered.
		* @param context application's context.
		*/
		protected abstract void onUnregistered(Context context,
		String registrationId);

		@Override
		public final void onHandleIntent(Intent intent) {
		try {
		Context context = getApplicationContext();
		String action = intent.getAction();
		if (action.equals(INTENT_FROM_GCM_REGISTRATION_CALLBACK)) {
		handleRegistration(context, intent);
		} else if (action.equals(INTENT_FROM_GCM_MESSAGE)) {
		// checks for special messages
		String messageType =
		intent.getStringExtra(EXTRA_SPECIAL_MESSAGE);
		if (messageType != null) {
		if (messageType.equals(VALUE_DELETED_MESSAGES)) {
		String sTotal =
		intent.getStringExtra(EXTRA_TOTAL_DELETED);
		if (sTotal != null) {
		try {
		int total = Integer.parseInt(sTotal);
		Log.v(TAG, "Received deleted messages " +
		"notification: " + total);
		onDeletedMessages(context, total);
		} catch (NumberFormatException e) {
		Log.e(TAG, "GCM returned invalid number of " +
		"deleted messages: " + sTotal);
		}
		}
		} else {
		// application is not using the latest GCM library
		Log.e(TAG, "Received unknown special message: " +
		messageType);
		}
		} else {
		onMessage(context, intent);
		}
		} else if (action.equals(INTENT_FROM_GCM_LIBRARY_RETRY)) {
		String token = intent.getStringExtra(EXTRA_TOKEN);
		if (!TOKEN.equals(token)) {
		// make sure intent was generated by this class, not by a
		// malicious app.
		Log.e(TAG, "Received invalid token: " + token);
		return;
		}
		// retry last call
		if (GCMRegistrar.isRegistered(context)) {
		GCMRegistrar.internalUnregister(context);
		} else {
		GCMRegistrar.internalRegister(context, mSenderId);
		}
		}
		} finally {
		// Release the power lock, so phone can get back to sleep.
		// The lock is reference-counted by default, so multiple
		// messages are ok.

		// If onMessage() needs to spawn a thread or do something else,
		// it should use its own lock.
		synchronized (LOCK) {
		// sanity check for null as this is a public method
		if (sWakeLock != null) {
		Log.v(TAG, "Releasing wakelock");
		sWakeLock.release();
		} else {
		// should never happen during normal workflow
		Log.e(TAG, "Wakelock reference is null");
		}
		}
		}
		}

		/**
		* Called from the broadcast receiver.
		* <p>
		* Will process the received intent, call handleMessage(), registered(),
		* etc. in background threads, with a wake lock, while keeping the service
		* alive.
		*/
		static void runIntentInService(Context context, Intent intent,
		String className) {
		synchronized (LOCK) {
		if (sWakeLock == null) {
		// This is called from BroadcastReceiver, there is no init.
		PowerManager pm = (PowerManager)
		context.getSystemService(Context.POWER_SERVICE);
		sWakeLock = pm.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK,
		WAKELOCK_KEY);
		}
		}
		Log.v(TAG, "Acquiring wakelock");
		sWakeLock.acquire();
		intent.setClassName(context, className);
		context.startService(intent);
		}

		private void handleRegistration(final Context context, Intent intent) {
		String registrationId = intent.getStringExtra(EXTRA_REGISTRATION_ID);
		String error = intent.getStringExtra(EXTRA_ERROR);
		String unregistered = intent.getStringExtra(EXTRA_UNREGISTERED);
		Log.d(TAG, "handleRegistration: registrationId = " + registrationId +
		", error = " + error + ", unregistered = " + unregistered);

		// registration succeeded
		if (registrationId != null) {
		GCMRegistrar.resetBackoff(context);
		GCMRegistrar.setRegistrationId(context, registrationId);
		onRegistered(context, registrationId);
		return;
		}

		// unregistration succeeded
		if (unregistered != null) {
		// Remember we are unregistered
		GCMRegistrar.resetBackoff(context);
		String oldRegistrationId =
		GCMRegistrar.clearRegistrationId(context);
		onUnregistered(context, oldRegistrationId);
		return;
		}

		// last operation (registration or unregistration) returned an error;
		Log.d(TAG, "Registration error: " + error);
		// Registration failed
		if (ERROR_SERVICE_NOT_AVAILABLE.equals(error)) {
		boolean retry = onRecoverableError(context, error);
		if (retry) {
		int backoffTimeMs = GCMRegistrar.getBackoff(context);
		int nextAttempt = backoffTimeMs / 2 +
		sRandom.nextInt(backoffTimeMs);
		Log.d(TAG, "Scheduling registration retry, backoff = " +
		nextAttempt + " (" + backoffTimeMs + ")");
		Intent retryIntent =
		new Intent(INTENT_FROM_GCM_LIBRARY_RETRY);
		retryIntent.putExtra(EXTRA_TOKEN, TOKEN);
		PendingIntent retryPendingIntent = PendingIntent
		.getBroadcast(context, 0, retryIntent, 0);
		AlarmManager am = (AlarmManager)
		context.getSystemService(Context.ALARM_SERVICE);
		am.set(AlarmManager.ELAPSED_REALTIME,
		SystemClock.elapsedRealtime() + nextAttempt,
		retryPendingIntent);
		// Next retry should wait longer.
		if (backoffTimeMs < MAX_BACKOFF_MS) {
		GCMRegistrar.setBackoff(context, backoffTimeMs * 2);
		}
		} else {
		Log.d(TAG, "Not retrying failed operation");
		}
		} else {
		// Unrecoverable error, notify app
		onError(context, error);
		}
		}

		}

src/android/com/google/android/gcm/GCMBroadcastReceiver.java

deleted100644 → 0

+0 −57

Changes for src/android/com/google/android/gcm/GCMBroadcastReceiver.java: 0 added lines, 57 removed lines.
Original line number	Diff line number	Diff line
		/*
		* Copyright 2012 Google Inc.
		*
		* 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.google.android.gcm;

		import static com.google.android.gcm.GCMConstants.DEFAULT_INTENT_SERVICE_CLASS_NAME;

		import android.app.Activity;
		import android.content.BroadcastReceiver;
		import android.content.Context;
		import android.content.Intent;
		import android.util.Log;

		/**
		* {@link BroadcastReceiver} that receives GCM messages and delivers them to
		* an application-specific {@link GCMBaseIntentService} subclass.
		* <p>
		* By default, the {@link GCMBaseIntentService} class belongs to the application
		* main package and is named
		* {@link GCMConstants#DEFAULT_INTENT_SERVICE_CLASS_NAME}. To use a new class,
		* the {@link #getGCMIntentServiceClassName(Context)} must be overridden.
		*/
		public class GCMBroadcastReceiver extends BroadcastReceiver {

		private static final String TAG = "GCMBroadcastReceiver";

		@Override
		public final void onReceive(Context context, Intent intent) {
		Log.v(TAG, "onReceive: " + intent.getAction());
		String className = getGCMIntentServiceClassName(context);
		Log.v(TAG, "GCM IntentService class: " + className);
		// Delegates to the application-specific intent service.
		GCMBaseIntentService.runIntentInService(context, intent, className);
		setResult(Activity.RESULT_OK, null /* data /, null / extra */);
		}

		/**
		* Gets the class name of the intent service that will handle GCM messages.
		*/
		protected String getGCMIntentServiceClassName(Context context) {
		return "com.google.android.gcm" + DEFAULT_INTENT_SERVICE_CLASS_NAME;
		}

		}

src/android/com/google/android/gcm/GCMConstants.java

deleted100644 → 0

+0 −161

Changes for src/android/com/google/android/gcm/GCMConstants.java: 0 added lines, 161 removed lines.
Original line number	Diff line number	Diff line
		/*
		* Copyright 2012 Google Inc.
		*
		* 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.google.android.gcm;

		/**
		* Constants used by the GCM library.
		*/
		public final class GCMConstants {

		/**
		* Intent sent to GCM to register the application.
		*/
		public static final String INTENT_TO_GCM_REGISTRATION =
		"com.google.android.c2dm.intent.REGISTER";

		/**
		* Intent sent to GCM to unregister the application.
		*/
		public static final String INTENT_TO_GCM_UNREGISTRATION =
		"com.google.android.c2dm.intent.UNREGISTER";

		/**
		* Intent sent by GCM indicating with the result of a registration request.
		*/
		public static final String INTENT_FROM_GCM_REGISTRATION_CALLBACK =
		"com.google.android.c2dm.intent.REGISTRATION";

		/**
		* Intent used by the GCM library to indicate that the registration call
		* should be retried.
		*/
		public static final String INTENT_FROM_GCM_LIBRARY_RETRY =
		"com.google.android.gcm.intent.RETRY";

		/**
		* Intent sent by GCM containing a message.
		*/
		public static final String INTENT_FROM_GCM_MESSAGE =
		"com.google.android.c2dm.intent.RECEIVE";

		/**
		* Extra used on {@link #INTENT_TO_GCM_REGISTRATION} to indicate the sender
		* account (a Google email) that owns the application.
		*/
		public static final String EXTRA_SENDER = "sender";

		/**
		* Extra used on {@link #INTENT_TO_GCM_REGISTRATION} to get the application
		* id.
		*/
		public static final String EXTRA_APPLICATION_PENDING_INTENT = "app";

		/**
		* Extra used on {@link #INTENT_FROM_GCM_REGISTRATION_CALLBACK} to indicate
		* that the application has been unregistered.
		*/
		public static final String EXTRA_UNREGISTERED = "unregistered";

		/**
		* Extra used on {@link #INTENT_FROM_GCM_REGISTRATION_CALLBACK} to indicate
		* an error when the registration fails. See constants starting with ERROR_
		* for possible values.
		*/
		public static final String EXTRA_ERROR = "error";

		/**
		* Extra used on {@link #INTENT_FROM_GCM_REGISTRATION_CALLBACK} to indicate
		* the registration id when the registration succeeds.
		*/
		public static final String EXTRA_REGISTRATION_ID = "registration_id";

		/**
		* Type of message present in the {@link #INTENT_FROM_GCM_MESSAGE} intent.
		* This extra is only set for special messages sent from GCM, not for
		* messages originated from the application.
		*/
		public static final String EXTRA_SPECIAL_MESSAGE = "message_type";

		/**
		* Special message indicating the server deleted the pending messages.
		*/
		public static final String VALUE_DELETED_MESSAGES = "deleted_messages";

		/**
		* Number of messages deleted by the server because the device was idle.
		* Present only on messages of special type
		* {@link #VALUE_DELETED_MESSAGES}
		*/
		public static final String EXTRA_TOTAL_DELETED = "total_deleted";

		/**
		* Permission necessary to receive GCM intents.
		*/
		public static final String PERMISSION_GCM_INTENTS =
		"com.google.android.c2dm.permission.SEND";

		/**
		* @see GCMBroadcastReceiver
		*/
		public static final String DEFAULT_INTENT_SERVICE_CLASS_NAME =
		".GCMIntentService";

		/**
		* The device can't read the response, or there was a 500/503 from the
		* server that can be retried later. The application should use exponential
		* back off and retry.
		*/
		public static final String ERROR_SERVICE_NOT_AVAILABLE =
		"SERVICE_NOT_AVAILABLE";

		/**
		* There is no Google account on the phone. The application should ask the
		* user to open the account manager and add a Google account.
		*/
		public static final String ERROR_ACCOUNT_MISSING =
		"ACCOUNT_MISSING";

		/**
		* Bad password. The application should ask the user to enter his/her
		* password, and let user retry manually later. Fix on the device side.
		*/
		public static final String ERROR_AUTHENTICATION_FAILED =
		"AUTHENTICATION_FAILED";

		/**
		* The request sent by the phone does not contain the expected parameters.
		* This phone doesn't currently support GCM.
		*/
		public static final String ERROR_INVALID_PARAMETERS =
		"INVALID_PARAMETERS";
		/**
		* The sender account is not recognized. Fix on the device side.
		*/
		public static final String ERROR_INVALID_SENDER =
		"INVALID_SENDER";

		/**
		* Incorrect phone registration with Google. This phone doesn't currently
		* support GCM.
		*/
		public static final String ERROR_PHONE_REGISTRATION_ERROR =
		"PHONE_REGISTRATION_ERROR";

		private GCMConstants() {
		throw new UnsupportedOperationException();
		}
		}