batterystatus.cpp

/*
 * Copyright (C) 2017 Jolla Ltd.
 * Contact: Raine Makelainen <raine.makelainen@jolla.com>
 *
 * You may use this file under the terms of the BSD license as follows:
 *
 * "Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *   * Neither the name of Nemo Mobile nor the names of its contributors
 *     may be used to endorse or promote products derived from this
 *     software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
 */

#include "batterystatus.h"
#include "batterystatus_p.h"

#include <QDBusServiceWatcher>
#include <QDBusConnection>

#include <mce/dbus-names.h>
#include <mce/mode-names.h>

namespace {
const QString MceSettingsChargingMode = QStringLiteral("/system/osso/dsm/charging/charging_mode");
const QString MceSettingsChargingLimitEnable = QStringLiteral("/system/osso/dsm/charging/limit_enable");
const QString MceSettingsChargingLimitDisable = QStringLiteral("/system/osso/dsm/charging/limit_disable");

const QString MceForcedChargingEnabled = QStringLiteral(MCE_FORCED_CHARGING_ENABLED);
const QString MceForcedChargingDisabled = QStringLiteral(MCE_FORCED_CHARGING_DISABLED);

const int MceChargingModeDisable = 0;
const int MceChargingModeEnable = 1;
const int MceChargingModeApplyThresholds = 2;
const int MceChargingModeApplyThresholdsAfterFull = 3;

bool chargingForcedFromDBus(const QString &value)
{
    return value == MceForcedChargingEnabled;
}

QString chargingForcedToDBus(bool enabled)
{
    return enabled ? MceForcedChargingEnabled : MceForcedChargingDisabled;
}

}

BatteryStatusPrivate::BatteryStatusPrivate(BatteryStatus *batteryInfo)
    : QObject(batteryInfo)
    , q(batteryInfo)
    , status(BatteryStatus::BatteryStatusUnknown)
    , chargingMode(BatteryStatus::EnableCharging)
    , chargerStatus(BatteryStatus::ChargerStatusUnknown)
    , chargePercentage(-1)
    , chargeEnableLimit(-1)
    , chargeDisableLimit(-1)
    , chargingForced(false)
    , chargingSuspendendable(false)
    , m_connection(QDBusConnection::systemBus())
    , m_mceInterface(this, m_connection, MCE_SERVICE, MCE_REQUEST_PATH, MCE_REQUEST_IF)
{
    QDBusServiceWatcher *mceWatcher = new QDBusServiceWatcher(MCE_SERVICE, QDBusConnection::systemBus(),
                                                              QDBusServiceWatcher::WatchForOwnerChange, this);

    connect(mceWatcher, &QDBusServiceWatcher::serviceRegistered,
            this, &BatteryStatusPrivate::mceRegistered);
    connect(mceWatcher, &QDBusServiceWatcher::serviceUnregistered,
            this, &BatteryStatusPrivate::mceUnregistered);

    registerSignals();

    // read initial values
    NemoDBus::Response *chargingMode = m_mceInterface.call(MCE_CONFIG_GET,
            MceSettingsChargingMode);
    chargingMode->onFinished<QVariant>([this](const QVariant &value) {
        chargingModeChanged(value.toInt());
    });
    chargingMode->onError([this](const QDBusError &error) {
        if (error.type() == QDBusError::ServiceUnknown) {
            // Service unknown => mce not registered. Signal initial state.
            emit q->chargingModeChanged(BatteryStatus::EnableCharging);
        }
    });

    NemoDBus::Response *chargingForced = m_mceInterface.call(MCE_FORCED_CHARGING_GET);
    chargingForced->onFinished<QString>([this](const QString &value) {
        chargingForcedChanged(value);
    });
    chargingForced->onError([this](const QDBusError &error) {
        if (error.type() == QDBusError::ServiceUnknown) {
            // Service unknown => mce not registered. Signal initial state.
            chargingForcedChanged(MceForcedChargingDisabled);
        }
    });

    NemoDBus::Response *chargerState = m_mceInterface.call(MCE_CHARGER_STATE_GET);
    chargerState->onFinished<QString>([this](const QString &value) {
        chargerStatusChanged(value);
    });
    chargerState->onError([this](const QDBusError &error) {
        if (error.type() == QDBusError::ServiceUnknown) {
            // Service unknown => mce not registered. Signal initial state.
            emit q->chargerStatusChanged(BatteryStatus::ChargerStatusUnknown);
        }
    });

    NemoDBus::Response *batteryState = m_mceInterface.call(MCE_BATTERY_STATUS_GET);
    batteryState->onFinished<QString>([this](const QString &value) {
        statusChanged(value);
    });
    batteryState->onError([this](const QDBusError &error) {
        if (error.type() == QDBusError::ServiceUnknown) {
            // Service unknown => mce not registered. Signal initial state.
            emit q->statusChanged(BatteryStatus::BatteryStatusUnknown);
        }
    });

    NemoDBus::Response *chargeEnableLimit = m_mceInterface.call(MCE_CONFIG_GET,
            MceSettingsChargingLimitEnable);
    chargeEnableLimit->onFinished<QVariant>([this](const QVariant &value) {
        chargeEnableLimitChanged(value.toInt());
    });
    chargeEnableLimit->onError([this](const QDBusError &error) {
        if (error.type() == QDBusError::ServiceUnknown) {
            // Service unknown => mce not registered. Signal initial state.
            emit q->chargeEnableLimitChanged(-1);
        }
    });

    NemoDBus::Response *chargeDisableLimit = m_mceInterface.call(MCE_CONFIG_GET,
            MceSettingsChargingLimitDisable);
    chargeDisableLimit->onFinished<QVariant>([this](const QVariant &value) {
        chargeDisableLimitChanged(value.toInt());
    });
    chargeDisableLimit->onError([this](const QDBusError &error) {
        if (error.type() == QDBusError::ServiceUnknown) {
            // Service unknown => mce not registered. Signal initial state.
            emit q->chargeDisableLimitChanged(-1);
        }
    });

    NemoDBus::Response *batteryLevel = m_mceInterface.call(MCE_BATTERY_LEVEL_GET);
    batteryLevel->onFinished<int>([this](int value) {
        chargePercentageChanged(value);
    });
    batteryLevel->onError([this](const QDBusError &error) {
        if (error.type() == QDBusError::ServiceUnknown) {
            // Service unknown => mce not registered. Signal initial state.
            emit q->chargePercentageChanged(-1);
        }
    });

    chargingSuspendabledRefresh();
}

BatteryStatusPrivate::~BatteryStatusPrivate()
{
}

void BatteryStatusPrivate::registerSignals()
{
    m_connection.connectToSignal(
            MCE_SERVICE, MCE_SIGNAL_PATH,
            MCE_SIGNAL_IF, MCE_CONFIG_CHANGE_SIG,
            this, SLOT(configChanged(QString,QDBusVariant)));
    m_connection.connectToSignal(
            MCE_SERVICE, MCE_SIGNAL_PATH,
            MCE_SIGNAL_IF, MCE_CHARGER_STATE_SIG,
            this, SLOT(chargerStatusChanged(QString)));
    m_connection.connectToSignal(
            MCE_SERVICE, MCE_SIGNAL_PATH,
            MCE_SIGNAL_IF, MCE_BATTERY_STATUS_SIG,
            this, SLOT(statusChanged(QString)));
    m_connection.connectToSignal(
            MCE_SERVICE, MCE_SIGNAL_PATH,
            MCE_SIGNAL_IF, MCE_BATTERY_LEVEL_SIG,
            this, SLOT(chargePercentageChanged(int)));
    m_connection.connectToSignal(
            MCE_SERVICE, MCE_SIGNAL_PATH,
            MCE_SIGNAL_IF, MCE_FORCED_CHARGING_SIG,
            this, SLOT(chargingForcedChanged(QString)));
}

BatteryStatus::ChargingMode BatteryStatusPrivate::parseChargingMode(int mode)
{
    switch (mode) {
    case MceChargingModeEnable:
        return BatteryStatus::EnableCharging;
    case MceChargingModeDisable:
        return BatteryStatus::DisableCharging;
    case MceChargingModeApplyThresholds:
        return BatteryStatus::ApplyChargingThresholds;
    case MceChargingModeApplyThresholdsAfterFull:
        return BatteryStatus::ApplyChargingThresholdsAfterFull;
    }

    return BatteryStatus::EnableCharging;
}

int BatteryStatusPrivate::chargingModeToInt(BatteryStatus::ChargingMode mode)
{
    switch (mode) {
    default:
    case BatteryStatus::EnableCharging:
        return MceChargingModeEnable;
    case BatteryStatus::DisableCharging:
        return MceChargingModeDisable;
    case BatteryStatus::ApplyChargingThresholds:
        return MceChargingModeApplyThresholds;
    case BatteryStatus::ApplyChargingThresholdsAfterFull:
        return MceChargingModeApplyThresholdsAfterFull;
    }
}

BatteryStatus::ChargerStatus BatteryStatusPrivate::parseChargerStatus(const QString &state)
{
    if (state == QLatin1String(MCE_CHARGER_STATE_ON)) {
        return BatteryStatus::Connected;
    } else if (state == QLatin1String(MCE_CHARGER_STATE_OFF)){
        return BatteryStatus::Disconnected;
    }

    return BatteryStatus::ChargerStatusUnknown;
}

BatteryStatus::Status BatteryStatusPrivate::parseBatteryStatus(const QString &status)
{
    if (status == QLatin1String(MCE_BATTERY_STATUS_LOW)) {
        return BatteryStatus::Low;
    } else if (status == QLatin1String(MCE_BATTERY_STATUS_OK)) {
        return BatteryStatus::Normal;
    } else if (status == QLatin1String(MCE_BATTERY_STATUS_EMPTY)) {
        return BatteryStatus::Empty;
    } else if (status == QLatin1String(MCE_BATTERY_STATUS_FULL)) {
        return BatteryStatus::Full;
    }

    return BatteryStatus::BatteryStatusUnknown;
}

void BatteryStatusPrivate::mceRegistered()
{
    registerSignals();
    chargingSuspendabledRefresh();
}

void BatteryStatusPrivate::mceUnregistered()
{
    chargerStatusChanged(QLatin1String(MCE_CHARGER_STATE_UNKNOWN));
    statusChanged(QLatin1String(MCE_BATTERY_STATUS_UNKNOWN));
    chargePercentageChanged(-1);
    chargingSuspendableChanged(false);
}

void BatteryStatusPrivate::configChanged(const QString &key, const QDBusVariant &value_)
{
    const QVariant value = value_.variant();

    if (key == MceSettingsChargingMode)
        chargingModeChanged(value.toInt());
    else if (key == MceSettingsChargingLimitEnable)
        chargeEnableLimitChanged(value.toInt());
    else if (key == MceSettingsChargingLimitDisable)
        chargeDisableLimitChanged(value.toInt());
}

void BatteryStatusPrivate::chargingModeChanged(int mode)
{
    BatteryStatus::ChargingMode newMode = parseChargingMode(mode);
    if (newMode != chargingMode) {
        chargingMode = newMode;
        emit q->chargingModeChanged(chargingMode);
    }
}

void BatteryStatusPrivate::chargingForcedChanged(const QString &forced)
{
    bool value = chargingForcedFromDBus(forced);
    if (value != chargingForced) {
        chargingForced = value;
        emit q->chargingForcedChanged(chargingForced);
    }
}

void BatteryStatusPrivate::chargingSuspendabledRefresh()
{
    NemoDBus::Response *chargingSuspendQuery = m_mceInterface.call(MCE_CHARGING_SUSPENDABLE_GET);
    chargingSuspendQuery->onFinished<bool>([this](bool value) {
        chargingSuspendableChanged(value);
    });
    chargingSuspendQuery->onError([this](const QDBusError &error) {
        Q_UNUSED(error);
        chargingSuspendableChanged(false);
    });
}

void BatteryStatusPrivate::chargingSuspendableChanged(bool supported)
{
    if (chargingSuspendendable != supported) {
        chargingSuspendendable = supported;
        emit q->chargingSuspendableChanged(chargingSuspendendable);
    }
}

void BatteryStatusPrivate::chargerStatusChanged(const QString &status)
{
    BatteryStatus::ChargerStatus newStatus = parseChargerStatus(status);
    if (newStatus != chargerStatus) {
        chargerStatus = newStatus;
        emit q->chargerStatusChanged(chargerStatus);
    }
}

void BatteryStatusPrivate::statusChanged(const QString &s)
{
    BatteryStatus::Status newStatus = parseBatteryStatus(s);
    if (newStatus != status) {
        status = newStatus;
        emit q->statusChanged(status);
    }
}

void BatteryStatusPrivate::chargePercentageChanged(int percentage)
{
    if (percentage != chargePercentage) {
        chargePercentage = percentage;
        emit q->chargePercentageChanged(chargePercentage);
    }
}

void BatteryStatusPrivate::chargeEnableLimitChanged(int percentage)
{
    if (percentage != chargeEnableLimit) {
        chargeEnableLimit = percentage;
        emit q->chargeEnableLimitChanged(chargeEnableLimit);
    }
}

void BatteryStatusPrivate::chargeDisableLimitChanged(int percentage)
{
    if (percentage != chargeDisableLimit) {
        chargeDisableLimit = percentage;
        emit q->chargeDisableLimitChanged(chargeDisableLimit);
    }
}

BatteryStatus::BatteryStatus(QObject *parent)
    : QObject(parent)
    , d_ptr(new BatteryStatusPrivate(this))
{
}

BatteryStatus::~BatteryStatus()
{
}

/**
 * @brief BatteryStatus::chargingMode
 * @return Returns active charging hysteresis policy mode. In case information cannot be read
 * EnableCharging is returned.
 */
BatteryStatus::ChargingMode BatteryStatus::chargingMode() const
{
    Q_D(const BatteryStatus);
    return d->chargingMode;
}

/**
 * @brief BatteryStatus::chargingForced
 * @return Returns true if forced charging is active
 */
bool BatteryStatus::chargingForced() const
{
    Q_D(const BatteryStatus);
    return d->chargingForced;
}

/**
 * @brief BatteryStatus::chargingSuspendendable
 * @return Returns true if charging can be suspended
 */
bool BatteryStatus::chargingSuspendendable() const
{
    Q_D(const BatteryStatus);
    return d->chargingSuspendendable;
}

/**
 * @brief BatteryStatus::setChargingMode
 * @param mode Charging hysteresis policy mode
 */
void BatteryStatus::setChargingMode(BatteryStatus::ChargingMode mode)
{
    Q_D(BatteryStatus);
    if (d->chargingMode != mode) {
        d->chargingMode = mode;
        d->m_mceInterface.call(MCE_CONFIG_SET, MceSettingsChargingMode,
                QDBusVariant(d->chargingModeToInt(mode)));
        emit chargingModeChanged(mode);
    }
}

/**
 * @brief BatteryStatus::setChargingForced
 * @param mode Charging hysteresis policy mode
 */
void BatteryStatus::setChargingForced(bool forced)
{
    Q_D(BatteryStatus);
    if (d->chargingForced != forced) {
        d->chargingForced = forced;
        d->m_mceInterface.call(MCE_FORCED_CHARGING_REQ,
                               chargingForcedToDBus(d->chargingForced));
        emit chargingForcedChanged(d->chargingForced);
    }
}

/**
 * @brief BatteryStatus::chargerStatus
 * @return Returns charger connected status. Returns Connected when power cord is connected (charging) and
 * Disconnected when charger is disconnected (discharging). In case information cannot be read ChargerStatusUnknown
 * is returned.
 */
BatteryStatus::ChargerStatus BatteryStatus::chargerStatus() const
{
    Q_D(const BatteryStatus);
    return d->chargerStatus;
}

/**
 * @brief BatteryStatus::batteryChargeLevel
 * @return Returns battery charge level, in case information cannot be read -1 is returned.
 */
int BatteryStatus::chargePercentage() const
{
    Q_D(const BatteryStatus);
    return d->chargePercentage;
}

/**
 * @brief BatteryStatus::chargeEnableLimit
 * @return Returns battery charge level under which charging should be enabled
 * @sa chargingMode
 */
int BatteryStatus::chargeEnableLimit() const
{
    Q_D(const BatteryStatus);
    return d->chargeEnableLimit;
}

/**
 * @brief BatteryStatus::setChargeEnableLimit
 * @param percentage Battery charge level under which charging should be enabled
 * @sa chargingMode
 */
void BatteryStatus::setChargeEnableLimit(int percentage)
{
    Q_D(BatteryStatus);
    if (d->chargeEnableLimit != percentage) {
        d->chargeEnableLimit = percentage;
        d->m_mceInterface.call(MCE_CONFIG_SET, MceSettingsChargingLimitEnable,
                QDBusVariant(percentage));
        emit chargeEnableLimitChanged(percentage);
    }
}

/**
 * @brief BatteryStatus::chargeDisableLimit
 * @return Returns battery charge level under which charging should be disabled
 * @sa chargingMode
 */
int BatteryStatus::chargeDisableLimit() const
{
    Q_D(const BatteryStatus);
    return d->chargeDisableLimit;
}

/**
 * @brief BatteryStatus::setChargeDisableLimit
 * @param percentage Battery charge level above which charging should be disabled
 * @sa chargingMode
 */
void BatteryStatus::setChargeDisableLimit(int percentage)
{
    Q_D(BatteryStatus);
    if (d->chargeDisableLimit != percentage) {
        d->chargeDisableLimit = percentage;
        d->m_mceInterface.call(MCE_CONFIG_SET, MceSettingsChargingLimitDisable,
                QDBusVariant(percentage));
        emit chargeDisableLimitChanged(percentage);
    }
}

/**
 * @brief BatteryStatus::status
 * @return Returns battery charge status
 */
BatteryStatus::Status BatteryStatus::status() const
{
    Q_D(const BatteryStatus);
    return d->status;
}