DeviceDAO.java

/*
 *  Copyright (C) 2010-2016 Stichting Akvo (Akvo Foundation)
 *
 *  This file is part of Akvo FLOW.
 *
 *  Akvo FLOW is free software: you can redistribute it and modify it under the terms of
 *  the GNU Affero General Public License (AGPL) as published by the Free Software Foundation,
 *  either version 3 of the License or any later version.
 *
 *  Akvo FLOW is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 *  without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *  See the GNU Affero General Public License included below for more details.
 *
 *  The full license text can also be seen at <http://www.gnu.org/licenses/agpl.html>.
 */

package com.gallatinsystems.device.dao;

import java.util.Date;
import java.util.logging.Logger;

import org.apache.commons.lang.StringUtils;

import com.gallatinsystems.device.domain.Device;
import com.gallatinsystems.device.domain.Device.DeviceType;
import com.gallatinsystems.framework.dao.BaseDAO;

/**
 * data access object for devices.
 *
 * @author Christopher Fagiani
 */
public class DeviceDAO extends BaseDAO<Device> {

    @SuppressWarnings("unused")
    private static final Logger log = Logger.getLogger(DeviceDAO.class
            .getName());

    public DeviceDAO() {
        super(Device.class);
    }

    /**
     * Get a single device based on available attributes. The priority given to these fields is:
     * androidId, imei, phoneNumber. If the device is not found using the most reliable fields,
     * we'll fall back to the next attr.
     *
     * @param androidId unique identifier. Reported from app v2.1.2 onwards
     * @param imei ESN number. Devices without a SIM card may not have this attr.
     * @param phoneNumber phone number or device MAC address
     * @return device matching this criteria, if found
     */
    public Device getDevice(String androidId, String imei, String phoneNumber) {
        Device device = null;

        if (StringUtils.isNotEmpty(androidId)) {
            // Devices registered with Flow app version > 2.1.2 will have reported
            // this attribute, which is the most reliable for identifying a device
            device = super.findByProperty("androidId", androidId, STRING_TYPE);
        }
        if (device == null && StringUtils.isNotEmpty(imei) && !"NO_IMEI".equals(imei)) {
            // WiFi only devices could have "NO_IMEI" as value
            // We want to fall back to search by `phoneNumber` (MAC address)
            device = super.findByProperty("esn", imei, STRING_TYPE);
        }

        if (device == null && StringUtils.isNotEmpty(phoneNumber)) {
            device = super.findByProperty("phoneNumber", phoneNumber, STRING_TYPE);
        }
        return device;
    }

    /**
     * Create or update device
     *
     * @param phoneNumber
     * @param lat
     * @param lon
     * @param accuracy
     * @param version
     * @param deviceIdentifier
     * @param imei
     */
    public void updateDevice(String phoneNumber, Double lat, Double lon,
            Double accuracy, String version, String deviceIdentifier,
            String imei, String osVersion, String androidId) {
        if (StringUtils.isEmpty(imei) && StringUtils.isEmpty(phoneNumber)) {
            return;
        }

        Device d = getDevice(androidId, imei, phoneNumber);
        if (d == null) {
            // if device is null, we have to create it
            d = new Device();
            d.setCreatedDateTime(new Date());
            d.setDeviceType(DeviceType.CELL_PHONE_ANDROID);
        }
        // Update device properties
        d.setPhoneNumber(phoneNumber);
        d.setAndroidId(androidId);
        d.setLastLocationBeaconTime(new Date());
        if (version != null && !version.trim().isEmpty()) {
            d.setGallatinSoftwareManifest(version);
        }
        if (lat != null && lon != null) {
            d.setLastKnownLat(lat);
            d.setLastKnownLon(lon);
            d.setLastKnownAccuracy(accuracy);
        }
        if (deviceIdentifier != null) {
            d.setDeviceIdentifier(deviceIdentifier);
        }
        if (imei != null && !Device.NO_IMEI.equals(imei)) {
            d.setEsn(imei);
        }
        if (osVersion != null) {
            d.setOsVersion(osVersion);
        }
        save(d);
    }
}