textmessage.cpp

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
#include "misc/network/textmessage.h"
 
#include <QStringBuilder>
#include <Qt>
#include <QtGlobal>
 
#include "misc/aviation/callsign.h"
#include "misc/aviation/comsystem.h"
#include "misc/aviation/selcal.h"
#include "misc/pq/constants.h"
#include "misc/pq/physicalquantity.h"
#include "misc/stringutils.h"
 
using namespace swift::misc::aviation;
using namespace swift::misc::physical_quantities;
 
SWIFT_DEFINE_VALUEOBJECT_MIXINS(swift::misc::network, CTextMessage)
 
namespace swift::misc::network
{
    CTextMessage::CTextMessage(const QString &message, const CFrequency &frequency, const CCallsign &senderCallsign)
        : m_senderCallsign(senderCallsign), m_frequency(frequency)
    {
        this->setMessage(message); // single place to modify message
        m_frequency.switchUnit(physical_quantities::CFrequencyUnit::MHz());
    }
 
    CTextMessage::CTextMessage(const QString &message, const CCallsign &senderCallsign,
                               const CCallsign &recipientCallsign)
        : m_senderCallsign(senderCallsign), m_recipientCallsign(recipientCallsign), m_frequency(0, nullptr)
    {
        this->setMessage(message); // single place to modify message
    }
 
    QString CTextMessage::convertToQString(bool i18n) const
    {
        if (this->isPrivateMessage())
        {
            return m_message % u' ' % m_senderCallsign.toQString(i18n) % u' ' % m_recipientCallsign.toQString(i18n);
        }
        return m_message % u' ' % m_frequency.toQString(i18n);
    }
 
    const QString &CTextMessage::swiftRelayMessage()
    {
        static const QString s("swift relayed: ");
        return s;
    }
 
    bool CTextMessage::isPrivateMessage() const
    {
        return !m_senderCallsign.isEmpty() && !m_recipientCallsign.isEmpty();
    }
 
    bool CTextMessage::isSupervisorMessage() const
    {
        // ignore broadcast messages
        if (this->isBroadcastMessage()) { return false; }
 
        // normal SUP message
        return m_senderCallsign.isSupervisorCallsign();
    }
 
    void CTextMessage::markAsSent()
    {
        m_wasSent = true;
        if (!this->hasValidTimestamp()) { this->setCurrentUtcTime(); }
    }
 
    bool CTextMessage::isRelayedMessage() const
    {
        return m_relayedMessage || this->getMessage().startsWith(CTextMessage::swiftRelayMessage());
    }
 
    void CTextMessage::markAsBroadcastMessage() {}
 
    void CTextMessage::makeRelayedMessage(const CCallsign &partnerCallsign)
    {
        if (this->getMessage().startsWith(CTextMessage::swiftRelayMessage())) { return; }
        const QString sender = this->getSenderCallsign().asString();
        const QString recipient = this->getRecipientCallsign().asString();
        this->markAsRelayedMessage();
        this->setRecipientCallsign(partnerCallsign);
        m_recipientCallsign.setTypeHint(CCallsign::Aircraft);
        const QString newMessage =
            CTextMessage::swiftRelayMessage() % sender % u" " % recipient % u";" % this->getMessage();
        m_message = newMessage;
    }
 
    bool CTextMessage::relayedMessageToPrivateMessage()
    {
        if (!this->isRelayedMessage()) { return false; }
        const int index = m_message.indexOf(';');
        if (index < CTextMessage::swiftRelayMessage().length()) { return false; }
        if (m_message.length() <= index + 1) { return false; } // no next line
        const QString senderRecipient = m_message.left(index).remove(CTextMessage::swiftRelayMessage()).trimmed();
        const QStringList sr = senderRecipient.split(' ');
        if (sr.size() != 2) { return false; }
        const QString originalSender = sr.first();
        const QString originalRecipient = sr.last();
        this->setSenderCallsign(CCallsign(originalSender)); // sender can be aircraft or ATC
        this->setRecipientCallsign(CCallsign(originalRecipient)); // recipient can be aircraft or ATC
        m_message = m_message.mid(index + 1);
        return true;
    }
 
    bool CTextMessage::canBeAppended(const CTextMessage &textMessage) const
    {
        if (textMessage.isEmpty()) { return false; }
        if (this->getSenderCallsign() != textMessage.getSenderCallsign()) { return false; }
        if (this->isRadioMessage() && textMessage.isRadioMessage())
        {
            return this->getFrequency() == textMessage.getFrequency();
        }
        else if (this->isPrivateMessage() && textMessage.isPrivateMessage())
        {
            return this->getRecipientCallsign() == textMessage.getRecipientCallsign();
        }
        return false;
    }
 
    bool CTextMessage::appendIfPossible(const CTextMessage &textMessage)
    {
        if (textMessage.isEmpty()) { return false; }
        if (!this->canBeAppended(textMessage)) { return false; }
        m_message += u' ' % textMessage.getMessage();
        return true;
    }
 
    QString CTextMessage::getRecipientCallsignOrFrequency() const
    {
        if (!m_recipientCallsign.isEmpty()) { return m_recipientCallsign.asString(); }
        if (m_frequency.isNull()) { return {}; }
        return m_frequency.valueRoundedWithUnit(CFrequencyUnit::MHz(), 3);
    }
 
    bool CTextMessage::isSendToFrequency(const CFrequency &frequency) const
    {
        if (!this->isRadioMessage()) { return false; }
        return m_frequency == frequency;
    }
 
    bool CTextMessage::isSendToUnicom() const
    {
        return this->isSendToFrequency(CPhysicalQuantitiesConstants::FrequencyUnicom());
    }
 
    bool CTextMessage::hasValidRecipient() const
    {
        if (!m_recipientCallsign.isEmpty()) { return true; }
        return CComSystem::isValidCivilAviationFrequency(m_frequency);
    }
 
    bool CTextMessage::mentionsCallsign(const CCallsign &callsign) const
    {
        if (callsign.isEmpty()) { return false; }
        if (m_message.length() < callsign.asString().length()) { return false; }
        return m_message.contains(callsign.asString(), Qt::CaseInsensitive);
    }
 
    QString CTextMessage::getAsciiOnlyMessage() const
    {
        if (m_message.isEmpty()) { return {}; }
        return asciiOnlyString(simplifyAccents(m_message));
    }
 
    QString CTextMessage::getHtmlEncodedMessage() const
    {
        if (m_message.isEmpty()) { return {}; }
        return m_message.toHtmlEscaped();
    }
 
    void CTextMessage::setMessage(const QString &message) { m_message = message.simplified().trimmed(); }
 
    bool CTextMessage::isRadioMessage() const { return (CComSystem::isValidCivilAviationFrequency(m_frequency)); }
 
    bool CTextMessage::isServerMessage() const
    {
        if (!this->isPrivateMessage()) { return false; }
        const CCallsign cs = this->getSenderCallsign();
        return (cs.asString().startsWith("SERVER", Qt::CaseInsensitive));
    }
 
    bool CTextMessage::isBroadcastMessage() const
    {
        const CCallsign cs = this->getRecipientCallsign();
        return cs.isBroadcastCallsign();
    }
 
    bool CTextMessage::isWallopMessage() const
    {
        const CCallsign cs = this->getRecipientCallsign();
        return cs.getStringAsSet() == "*S";
    }
 
    QString CTextMessage::asString(bool withSender, bool withRecipient, const QString &separator) const
    {
        QString s(this->getFormattedUtcTimestampHms());
        if (withSender)
        {
            if (!m_senderCallsign.isEmpty())
            {
                if (!s.isEmpty()) { s += separator % m_senderCallsign.getStringAsSet(); }
            }
        }
 
        if (withRecipient)
        {
            if (!m_recipientCallsign.isEmpty())
            {
                if (!s.isEmpty()) { s += separator % m_recipientCallsign.getStringAsSet(); }
            }
            else
            {
                if (CComSystem::isValidCivilAviationFrequency(m_frequency))
                {
                    if (!s.isEmpty()) { s += separator % m_frequency.valueRoundedWithUnit(3, true); }
                }
            }
        } // to
 
        if (m_message.isEmpty()) { return s; }
        if (!s.isEmpty()) { s += separator % m_message; }
        return s;
    }
 
    CStatusMessage CTextMessage::asStatusMessage(bool withSender, bool withRecipient, const QString &separator) const
    {
        const QString m = this->asString(withSender, withRecipient, separator);
        return { this, CStatusMessage::SeverityInfo, m };
    }
 
    QString CTextMessage::asHtmlSummary(const QString &separator) const
    {
        return this->asString(true, true, separator);
    }
 
    void CTextMessage::toggleSenderRecipient() { std::swap(m_senderCallsign, m_recipientCallsign); }
 
    bool CTextMessage::isSelcalMessage() const
    {
        // some first level checks, before really parsing the message
        if (this->isEmpty()) { return false; }
        if (this->isPrivateMessage()) { return false; }
        if (m_message.length() > 15 || m_message.length() < 10)
        {
            return false;
        } // SELCAL AB-CD -> 12, I allow some more characters as I do not know wheter in real life it exactly matches
        return this->getSelcalCode().length() == 4;
    }
 
    bool CTextMessage::isSelcalMessageFor(const QString &selcal) const
    {
        if (!CSelcal::isValidCode(selcal)) return false;
        return selcal.toUpper() == this->getSelcalCode();
    }
 
    QString CTextMessage::getSelcalCode() const
    {
        // http://forums.vatsim.net/viewtopic.php?f=8&t=63467#p458062
        // When the ATC client sends a selcal, it goes out as a text message
        // on their primary frequency, formatted like so:
        // SELCAL AB-CD
 
        if (this->isEmpty()) return {};
        if (this->isPrivateMessage()) return {};
        if (!m_message.startsWith(QLatin1String("SELCAL"), Qt::CaseInsensitive)) return {};
        if (m_message.length() > 15 || m_message.length() < 10)
            return {}; // SELCAL AB-CD -> 12, I allow some more characters as I do not know wheter in real life it
                       // exactly matches
        QString candidate = removeChars(m_message, [](QChar c) { return !c.isLetter(); }); // SELCALABCD
        if (candidate.length() != 10) return {};
        return std::move(candidate).right(4).toUpper();
    }
 
    CIcons::IconIndex CTextMessage::toIcon() const { return m_senderCallsign.toIcon(); }
 
    QPixmap CTextMessage::toPixmap() const { return CIcon(toIcon()).toPixmap(); }
 
    QVariant CTextMessage::propertyByIndex(swift::misc::CPropertyIndexRef index) const
    {
        if (index.isMyself()) { return QVariant::fromValue(*this); }
        if (ITimestampBased::canHandleIndex(index)) { return ITimestampBased::propertyByIndex(index); }
 
        const auto i = index.frontCasted<ColumnIndex>();
        switch (i)
        {
        case IndexSenderCallsign: return m_senderCallsign.propertyByIndex(index.copyFrontRemoved());
        case IndexRecipientCallsign: return m_recipientCallsign.propertyByIndex(index.copyFrontRemoved());
        case IndexRecipientCallsignOrFrequency: return QVariant::fromValue(this->getRecipientCallsignOrFrequency());
        case IndexMessage: return QVariant::fromValue(m_message);
        default: return CValueObject::propertyByIndex(index);
        }
    }
 
    void CTextMessage::setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant)
    {
        if (index.isMyself())
        {
            (*this) = variant.value<CTextMessage>();
            return;
        }
        if (ITimestampBased::canHandleIndex(index))
        {
            ITimestampBased::setPropertyByIndex(index, variant);
            return;
        }
 
        const auto i = index.frontCasted<ColumnIndex>();
        switch (i)
        {
        case IndexSenderCallsign: m_senderCallsign.setPropertyByIndex(index.copyFrontRemoved(), variant); break;
        case IndexRecipientCallsign: m_recipientCallsign.setPropertyByIndex(index.copyFrontRemoved(), variant); break;
        case IndexMessage: m_message = variant.value<QString>(); break;
        default: CValueObject::setPropertyByIndex(index, variant); break;
        }
    }
 
    int CTextMessage::comparePropertyByIndex(CPropertyIndexRef index, const CTextMessage &compareValue) const
    {
        if (ITimestampBased::canHandleIndex(index))
        {
            return ITimestampBased::comparePropertyByIndex(index, compareValue);
        }
        const auto i = index.frontCasted<ColumnIndex>();
        switch (i)
        {
        case IndexSenderCallsign:
            return m_senderCallsign.comparePropertyByIndex(index.copyFrontRemoved(), compareValue.getSenderCallsign());
        case IndexRecipientCallsign:
            return m_recipientCallsign.comparePropertyByIndex(index.copyFrontRemoved(),
                                                              compareValue.getRecipientCallsign());
        case IndexRecipientCallsignOrFrequency:
            if (this->isRadioMessage()) { return this->getFrequency().compare(compareValue.getFrequency()); }
            return m_recipientCallsign.comparePropertyByIndex(index.copyFrontRemoved(),
                                                              compareValue.getRecipientCallsign());
        default: return CValueObject::comparePropertyByIndex(index, *this);
        }
        Q_ASSERT_X(false, Q_FUNC_INFO, "No comparison");
        return 0;
    }
} // namespace swift::misc::network