NetworkConnectivityReceiver.java

/*
 * Copyright 2015 OpenMarket Ltd
 *
 * 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 org.matrix.androidsdk.network;

import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.net.ConnectivityManager;
import android.net.NetworkInfo;
import android.os.Bundle;
import org.matrix.androidsdk.util.Log;

import org.matrix.androidsdk.listeners.IMXNetworkEventListener;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;

public class NetworkConnectivityReceiver extends BroadcastReceiver {

    private static final String LOG_TAG = "NetworkReceiver";

    // any network state listener
    private final List<IMXNetworkEventListener> mNetworkEventListeners = new ArrayList<>();

    // the one call listeners are listeners which are expected to be called ONCE
    // the device is connected to a data network
    private final List<IMXNetworkEventListener> mOnNetworkConnectedEventListeners = new ArrayList<>();

    private boolean mIsConnected = false;

    @Override
    public void onReceive(final Context context, final Intent intent) {
        if (null != intent) {
            Log.d(LOG_TAG, "## onReceive() : action " + intent.getAction());

            Bundle extras =intent.getExtras();

            if (null != extras) {
                Set<String> keys = extras.keySet();

                for(String key : keys) {
                    Log.d(LOG_TAG, "## onReceive() : " + key + " -> " + extras.get(key));
                }
            }
        } else {
            Log.d(LOG_TAG, "## onReceive()");
        }

        checkNetworkConnection(context);
    }

    /**
     * Check if there is a connection update.
     * @param context the context
     */
    public void checkNetworkConnection(Context context) {
        synchronized (LOG_TAG) {
            try {
                ConnectivityManager connMgr = (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
                NetworkInfo networkInfo = connMgr.getActiveNetworkInfo();
                boolean isConnected = (networkInfo != null) && networkInfo.isConnected();

                if (isConnected) {
                    Log.d(LOG_TAG, "## checkNetworkConnection() : Connected to " + networkInfo);
                } else if (null != networkInfo) {
                    Log.d(LOG_TAG, "## checkNetworkConnection() : there is a default connection but it is not connected " + networkInfo);
                } else {
                    Log.d(LOG_TAG, "## checkNetworkConnection() : there is no connection");
                }

                // avoid triggering useless info
                if (mIsConnected != isConnected) {
                    Log.d(LOG_TAG, "## checkNetworkConnection() : Warn there is a connection update");
                    mIsConnected = isConnected;
                    onNetworkUpdate();
                } else {
                    Log.d(LOG_TAG, "## checkNetworkConnection() : No network update");
                }
            } catch (Exception e) {
                Log.e(LOG_TAG, "Failed to report :" + e.getMessage());
            }
        }
    }

    /**
     * Add a network event listener.
     * @param networkEventListener the event listener to add
     */
    public void addEventListener(final IMXNetworkEventListener networkEventListener) {
        if (null != networkEventListener) {
            mNetworkEventListeners.add(networkEventListener);
        }
    }

    /**
     * Add a ONE CALL network event listener.
     * The listener is called when a data connection is established.
     * The listener is removed from the listeners list once its callback is called.
     * @param networkEventListener the event listener to add
     */
    public void addOnConnectedEventListener(final IMXNetworkEventListener networkEventListener) {
        if (null != networkEventListener) {
            synchronized (LOG_TAG) {
                mOnNetworkConnectedEventListeners.add(networkEventListener);
            }
        }
    }

    /**
     * Remove a network event listener.
     * @param networkEventListener the event listener to remove
     */
    public void removeEventListener(final IMXNetworkEventListener networkEventListener) {
        synchronized (LOG_TAG) {
            mNetworkEventListeners.remove(networkEventListener);
            mOnNetworkConnectedEventListeners.remove(networkEventListener);
        }
    }

    /**
     * Remove all registered listeners
     */
    public void removeListeners() {
        synchronized (LOG_TAG) {
            mNetworkEventListeners.clear();
            mOnNetworkConnectedEventListeners.clear();
        }
    }

    /**
     * Warn the listener that a network updated has been triggered
     */
    private synchronized void onNetworkUpdate() {
        for (IMXNetworkEventListener listener : mNetworkEventListeners) {
            try {
                listener.onNetworkConnectionUpdate(mIsConnected);
            } catch (Exception e) {
                Log.e(LOG_TAG, "## onNetworkUpdate() : onNetworkConnectionUpdate failed " + e.getMessage());
            }
        }

        // onConnected listeners are called once
        // and only when there is an available network connection
        if (mIsConnected) {
            for (IMXNetworkEventListener listener : mOnNetworkConnectedEventListeners) {
                try {
                    listener.onNetworkConnectionUpdate(true);
                } catch(Exception e) {
                    Log.e(LOG_TAG, "## onNetworkUpdate() : onNetworkConnectionUpdate failed " + e.getMessage());
                }
            }

            mOnNetworkConnectedEventListeners.clear();
        }
    }

    /**
     * @return true if the application is connected to a data network
     */
    public boolean isConnected() {
        boolean res;

        synchronized (LOG_TAG) {
            res = mIsConnected;
        }

        Log.d(LOG_TAG, "## isConnected() : " + res);

        return res;
    }
}