kde-workspace/kcontrol/dateandtime/kcm_clock.cpp

/*
    This file is part of the KDE project
    Copyright (C) 2024 Ivailo Monev <xakepa10@gmail.com>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2, as published by the Free Software Foundation.

    This library 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#include "kcm_clock.h"

#include <QThread>
#include <QHeaderView>
#include <QJsonDocument>
#include <kaboutdata.h>
#include <kpluginfactory.h>
#include <kauthorization.h>
#include <ksystemtimezone.h>
#include <kstandarddirs.h>
#include <kmessagebox.h>
#include <kio/job.h>
#include <kio/jobclasses.h>
#include <kio/netaccess.h>
#include <kdebug.h>

static const int s_updatetime = 1000;
static const int s_waittime = 100;
static const QString s_dateformat = QString::fromLatin1("yyyy-MM-dd HH:mm:ss");
static const QString s_utczone = QString::fromLatin1("UTC");
static const QString s_timeapi = QString::fromLatin1("http://worldtimeapi.org/api/timezone/UTC");

static void kWatiForTimeZone(const QString &zonename)
{
    while (KSystemTimeZones::local().name() != zonename) {
        QCoreApplication::processEvents(QEventLoop::AllEvents, s_waittime);
        QThread::msleep(s_waittime);
    }
}

static bool kCanChangeClock()
{
    return (!KStandardDirs::findRootExe("hwclock").isEmpty() || !KStandardDirs::findRootExe("timedatectl").isEmpty());
}

KCMClockSearch::KCMClockSearch(QWidget *parent)
    : KTreeWidgetSearchLine(parent)
{
}

bool KCMClockSearch::itemMatches(const QTreeWidgetItem *item, const QString &pattern) const
{
    if (KTreeWidgetSearchLine::itemMatches(item, pattern)) {
        return true;
    }
    // try harder with the user data in Qt::UserRole
    const QString userdata0 = item->data(0, Qt::UserRole).toString();
    if (userdata0.indexOf(pattern, 0, caseSensitivity()) >= 0) {
        // untranslated zone name column matches
        return true;
    }
    // maybe untranslated zone comment match
    const QString userdata1 = item->data(1, Qt::UserRole).toString();
    return (userdata1.indexOf(pattern, 0, caseSensitivity()) >= 0);
}


K_PLUGIN_FACTORY(KCMClockFactory, registerPlugin<KCMClock>();)
K_EXPORT_PLUGIN(KCMClockFactory("kcmclock", "kcmclock"))

KCMClock::KCMClock(QWidget *parent, const QVariantList &args)
    : KCModule(KCMClockFactory::componentData(), parent),
    m_layout(nullptr),
    m_canchangeclock(false),
    m_messagewidget(nullptr),
    m_datetimebox(nullptr),
    m_datetimelayout(nullptr),
    m_timeedit(nullptr),
    m_dateedit(nullptr),
    m_timezonebox(nullptr),
    m_timezonelayout(nullptr),
    m_timezonesearch(nullptr),
    m_timezonewidget(nullptr),
    m_timer(nullptr),
    m_timechanged(false),
    m_datechanged(false),
    m_zonechanged(false)
{
    Q_UNUSED(args);

    setButtons(KCModule::Default | KCModule::Apply);
    setQuickHelp(i18n("<h1>Date and Time</h1> This module allows you to change system date and time options."));

    KAboutData *about = new KAboutData(
        I18N_NOOP("kcmclock"), 0,
        ki18n("KDE Date and Time Module"),
        0, KLocalizedString(), KAboutData::License_GPL,
        ki18n("Copyright 2024, Ivailo Monev xakepa10@gmail.com")
    );
    about->addAuthor(ki18n("Ivailo Monev"), KLocalizedString(), "xakepa10@gmail.com");
    setAboutData(about);

    m_layout = new QVBoxLayout(this);
    setLayout(m_layout);

    m_canchangeclock = kCanChangeClock();
    m_messagewidget = new KMessageWidget(this);
    m_messagewidget->setMessageType(KMessageWidget::Warning);
    m_messagewidget->setCloseButtonVisible(false);
    m_messagewidget->setText(i18n("Neither 'hwclock' nor 'timedatectl' utility found, setting the date and time is not possible."));
    m_messagewidget->setVisible(!m_canchangeclock);
    m_layout->addWidget(m_messagewidget);

    m_datetimebox = new QGroupBox(this);
    m_datetimebox->setTitle(i18n("Date and time"));
    m_datetimelayout = new QHBoxLayout(m_datetimebox);
    m_datetimebox->setLayout(m_datetimelayout);
    m_timeedit = new QTimeEdit(m_datetimebox);
    // to show seconds the time format has to be in C locale
    m_timeedit->setLocale(QLocale::c());
    connect(m_timeedit, SIGNAL(timeChanged(QTime)), this, SLOT(slotTimeChanged()));
    m_datetimelayout->addWidget(m_timeedit);
    m_dateedit = new QDateEdit(m_datetimebox);
    m_dateedit->setLocale(KGlobal::locale()->toLocale());
    connect(m_dateedit, SIGNAL(dateChanged(QDate)), this, SLOT(slotDateChanged()));
    m_datetimelayout->addWidget(m_dateedit);
    m_layout->addWidget(m_datetimebox);

    m_timezonebox = new QGroupBox(this);
    m_timezonebox->setTitle(i18n("Time zone"));
    m_timezonelayout = new QVBoxLayout(m_timezonebox);
    m_timezonebox->setLayout(m_timezonelayout);
    m_timezonesearch = new KCMClockSearch(m_timezonebox);
    m_timezonesearch->setClickMessage(i18n("Search"));
    m_timezonelayout->addWidget(m_timezonesearch);
    m_timezonewidget = new QTreeWidget(m_timezonebox);
    m_timezonewidget->setSelectionMode(QAbstractItemView::SingleSelection);
    m_timezonewidget->setColumnCount(2);
    QStringList treeheaders = QStringList()
        << i18n("Time zone")
        << i18n("Comment");
    m_timezonewidget->setHeaderLabels(treeheaders);
    m_timezonewidget->setRootIsDecorated(false);
    m_timezonewidget->header()->setMovable(false);
    m_timezonewidget->header()->setStretchLastSection(false);
    m_timezonewidget->header()->setResizeMode(0, QHeaderView::Stretch);
    m_timezonewidget->header()->setResizeMode(1, QHeaderView::Stretch);
    QMap<QString, QString> sortedzones;
    foreach (const KTimeZone &ktimezone, KSystemTimeZones::zones()) {
        const QString zonename = ktimezone.name();
        sortedzones.insert(KSystemTimeZones::zoneName(zonename), zonename);
    }
    QMapIterator<QString, QString> sortedzonesiter(sortedzones);
    while (sortedzonesiter.hasNext()) {
        sortedzonesiter.next();
        const QString zonename = sortedzonesiter.value();
        const KTimeZone ktimezone = KSystemTimeZones::zone(zonename);
        const QString zoneflag = KStandardDirs::locate(
            "locale",
            QString::fromLatin1("l10n/%1/flag.png").arg(ktimezone.countryCode().toLower())
        );;
        QTreeWidgetItem* zoneitem = new QTreeWidgetItem();
        zoneitem->setData(0, Qt::UserRole, zonename);
        zoneitem->setIcon(0, KIcon(zoneflag));
        zoneitem->setText(0, sortedzonesiter.key());
        zoneitem->setData(1, Qt::UserRole, ktimezone.comment());
        zoneitem->setText(1, KSystemTimeZones::zoneComment(zonename));
        m_timezonewidget->addTopLevelItem(zoneitem);
    }
    connect(m_timezonewidget, SIGNAL(itemSelectionChanged()), this, SLOT(slotZoneChanged()));
    m_timezonesearch->setTreeWidget(m_timezonewidget);
    m_timezonelayout->addWidget(m_timezonewidget);
    m_layout->addWidget(m_timezonebox);

    m_timer = new QTimer(this);
    m_timer->setInterval(s_updatetime);
    connect(m_timer, SIGNAL(timeout()), this, SLOT(slotUpdate()));
}

void KCMClock::save()
{
    setEnabled(false);
    m_timer->stop();
    m_timechanged = false;
    m_datechanged = false;
    m_zonechanged = false;
    QVariantMap savearguments;
    QString zonename;
    const QList<QTreeWidgetItem*> selectedzones = m_timezonewidget->selectedItems();
    if (selectedzones.isEmpty()) {
        zonename = s_utczone; // what else?
    } else {
        zonename = selectedzones.at(0)->data(0, Qt::UserRole).toString();
    }
    // qDebug() << Q_FUNC_INFO << zonename;
    savearguments.insert("zonename", zonename);
    if (m_canchangeclock) {
        // NOTE: the time passed to the utilities has to be in localtime, when the zone is UTC
        // the time is in UTC so it has to be converted first
        const QDateTime datetime = QDateTime(
            m_dateedit->date(), m_timeedit->time(),
            zonename == s_utczone ? Qt::UTC : Qt::LocalTime
        );
        savearguments.insert("datetime", datetime.toLocalTime().toString(s_dateformat));
        // qDebug() << Q_FUNC_INFO << datetime;
    }
    const int clockreply = KAuthorization::execute(
        "org.kde.kcontrol.kcmclock", "save", savearguments
    );
    if (clockreply > 0) {
        if (clockreply == 1) {
            KMessageBox::error(this, i18n("Unable to set date and time"));
            kWatiForTimeZone(zonename);
        } else if (clockreply == 2) {
            KMessageBox::error(this, i18n("Unable to set timezone"));
        }
    } else if (clockreply != KAuthorization::NoError) {
        KMessageBox::error(this, i18n("Unable to authenticate/execute the action: %1", KAuthorization::errorString(clockreply)));
    } else {
        kWatiForTimeZone(zonename);
    }
    slotUpdate();
    emit changed(false);
    m_timer->start();
    setEnabled(true);
}

void KCMClock::load()
{
    setEnabled(false);
    if (!KAuthorization::isAuthorized("org.kde.kcontrol.kcmclock")) {
        setUseRootOnlyMessage(true);
        setRootOnlyMessage(i18n("You are not allowed to save the configuration"));
        setDisabled(true);
    }
    m_canchangeclock = kCanChangeClock();
    m_messagewidget->setVisible(!m_canchangeclock);
    m_timeedit->setEnabled(m_canchangeclock);
    m_dateedit->setEnabled(m_canchangeclock);
    m_timechanged = false;
    m_datechanged = false;
    m_zonechanged = false;
    slotUpdate();
    emit changed(false);
    m_timer->start();
    setEnabled(true);
}

void KCMClock::defaults()
{
    setEnabled(false);
    m_timer->stop();
    if (m_canchangeclock) {
        KIO::StoredTransferJob* kiojob = KIO::storedGet(KUrl(s_timeapi), KIO::HideProgressInfo);
        kiojob->setAutoDelete(false);
        const bool kioresult = KIO::NetAccess::synchronousRun(kiojob, this);
        if (kioresult) {
            // qDebug() << Q_FUNC_INFO << kiojob->data();
            const QJsonDocument jsondocument = QJsonDocument::fromJson(kiojob->data());
            if (jsondocument.isNull()) {
                const QString jsonerror = jsondocument.errorString();
                kWarning() << "could not parse JSON" << jsonerror;
                KMessageBox::error(this, jsonerror, i18n("Could not parse JSON"));
            } else {
                const QVariantMap jsonmap = jsondocument.toVariant().toMap();
                const QString datetimesting = jsonmap.value("datetime").toString();
                const QDateTime datetime = QDateTime::fromString(datetimesting, Qt::ISODate);
                // qDebug() << Q_FUNC_INFO << datetime;
                if (datetime.isValid()) {
                    // TODO: the time has to keep ticking
                    m_timeedit->setTime(datetime.time());
                    m_dateedit->setDate(datetime.date());
                } else {
                    KMessageBox::error(this, i18n("Invalid date and time"), i18n("Invalid date and time"));
                }
            }
        } else {
            const QString kioerror = kiojob->errorString();
            kWarning() << "could not get the UTC time" << kioerror;
            KMessageBox::error(this, kioerror, i18n("Could not get the UTC time"));
        }
        kiojob->deleteLater();
    }
    selectTimeZone(s_utczone);
    m_timer->start();
    setEnabled(true);
}

void KCMClock::selectTimeZone(const QString &name)
{
    for (int i = 0; i < m_timezonewidget->topLevelItemCount(); i++) {
        QTreeWidgetItem* zoneitem = m_timezonewidget->topLevelItem(i);
        if (zoneitem->data(0, Qt::UserRole).toString() == name) {
            m_timezonewidget->setCurrentItem(zoneitem, 0);
            return;
        }
    }
    kWarning() << "timezone not in the tree" << name;
}

void KCMClock::slotUpdate()
{
    const QDateTime now = QDateTime::currentDateTime();
    if (!m_timechanged) {
        // do not update while text has been selected otherwise selection changes, the value will
        // be updated once selection is cleared
        QLineEdit* timeeditlineedit = m_timeedit->findChild<QLineEdit*>();
        if (!timeeditlineedit || !timeeditlineedit->hasSelectedText()) {
            m_timeedit->blockSignals(true);
            m_timeedit->setTime(now.time());
            m_timeedit->blockSignals(false);
        }
    }
    if (!m_datechanged) {
        m_dateedit->blockSignals(true);
        m_dateedit->setDate(now.date());
        m_dateedit->blockSignals(false);
    }
    if (!m_zonechanged) {
        m_timezonewidget->blockSignals(true);
        selectTimeZone(KSystemTimeZones::local().name());
        m_timezonewidget->blockSignals(false);
    }
}

void KCMClock::slotTimeChanged()
{
    m_timechanged = true;
    emit changed(true);
}

void KCMClock::slotDateChanged()
{
    m_datechanged = true;
    emit changed(true);
}

void KCMClock::slotZoneChanged()
{
    m_zonechanged = true;
    emit changed(true);
}

#include "moc_kcm_clock.cpp"