lcdserver.cpp

Go to the documentation of this file.

/*
    lcdserver.cpp

    Methods for the core lcdserver object
*/


/*
    Command list

    SWITCH_TO_TIME
    SWITCH_TO_MUSIC "Artist" "Album" "Track"
    SWITCH_TO_VOLUME "AppName"
    SWITCH_TO_CHANNEL "ChanNum" "Title" "SubTitle"
    SWITCH_TO_NOTHING
    SWITCH_TO_MENU AppName popup ["Text" Checked Selected Scroll Indent ...]
        AppName is a string
        Popup can be TRUE or FALSE
        Text is a string
        Checked can be CHECKED, UNCHECKED, NOTCHECKABLE
        Selected can be TRUE or FALSE
        Scroll can be TRUE or FALSE
        Indent is an integer
        ... repeat as required

    SWITCH_TO_GENERIC RowNo Align "Text" "Screen" Scrollable ...
        RowNo is an integer
        Align can be ALIGN_LEFT, ALIGN_RIGHT, ALIGN_CENTERED
        Scrollable can be TRUE or FALSE
        ... repeat as required

    SET_VOLUME_LEVEL <level>
        level is a float between 0.0 and 1.0

    SET_CHANNEL_PROGRESS <progress>
        progress is a float between 0.0 and 1.0

    SET_MUSIC_PROGRESS "Time" <progress>
        time is a string
        progress is a float between 0.0 and 1.0

    SET_MUSIC_PLAYER_PROP <field> <val>
        field is a string, currently SHUFFLE or REPEAT
        val depends on field, currently integer

    SET_GENERIC_PROGRESS <busy> <progress>
        busy is 0 for busy spinner, 0 for normal progess bar
        progress is a float between 0.0 and 1.0

    UPDATE_LEDS

    STOP_ALL

    RESET

*/

#include <cstdlib>

#include <QCoreApplication>
#include <QDir>
#include <QList>
#include <QRegExp>
#include <QStringList>
#include <utility>

#include "mythdate.h"
#include "mythcontext.h"
#include "lcddevice.h"

#include "lcdserver.h"

int debug_level = 0;

#define LOC      QString("LCDServer: ")
#define LOC_WARN QString("LCDServer, Warning: ")
#define LOC_ERR  QString("LCDServer, Error: ")

LCDServer::LCDServer(int port, QString message, int messageTime)
    : m_lcd(new LCDProcClient(this)),
     m_serverPool(new ServerPool()),
     m_lastSocket(nullptr)
{
    if (!m_lcd->SetupLCD())
    {
        delete m_lcd;
        m_lcd = nullptr;
    }

    connect(m_serverPool, SIGNAL(newConnection(QTcpSocket*)),
            this,         SLOT(newConnection(QTcpSocket*)));

    if (!m_serverPool->listen(port))
    {
        LOG(VB_GENERAL, LOG_ERR, "There is probably a copy of mythlcdserver "
            "already running. You can verify this by running: \n"
            "'ps ax | grep mythlcdserver'");
        delete m_serverPool;
        return;
    }

    if (m_lcd)
        m_lcd->setStartupMessage(std::move(message), messageTime);
}

void LCDServer::newConnection(QTcpSocket *socket)
{
    connect(socket, SIGNAL(readyRead()),
            this,   SLOT(  readSocket()));
    connect(socket, SIGNAL(disconnected()),
            this,   SLOT(  endConnection()));

    if (debug_level > 0)
        LOG(VB_NETWORK, LOG_INFO, "LCDServer: new connection");

    if (m_lcd)
        m_lcd->switchToTime();
}

void LCDServer::endConnection(void)
{
    auto *socket = dynamic_cast<QTcpSocket*>(sender());
    if (socket)
    {
        socket->close();
        socket->deleteLater();
        if (debug_level > 0)
            LOG(VB_NETWORK, LOG_INFO, "LCDServer: close connection");
    }

    if (m_lastSocket == socket)
        m_lastSocket = nullptr;
}

void LCDServer::readSocket()
{
    auto *socket = dynamic_cast<QTcpSocket*>(sender());
    if (socket)
    {
        m_lastSocket = socket;

        while(socket->canReadLine())
        {
            QString incoming_data = socket->readLine();
            incoming_data = incoming_data.replace( QRegExp("\n"), "" );
            incoming_data = incoming_data.replace( QRegExp("\r"), "" );
            incoming_data = incoming_data.simplified();
            QStringList tokens = parseCommand(incoming_data);
            parseTokens(tokens, socket);
        }
    }
}

QStringList LCDServer::parseCommand(QString &command)
{
    QStringList tokens;
    QString s = "";
    QChar c;
    bool bInString = false;

    for (int x = 0; x < command.length(); x++)
    {
        c = command[x];
        if (!bInString && c == '"')
            bInString = true;
        else if (bInString && c == '"')
            bInString = false;
        else if (!bInString && c == ' ')
        {
            tokens.append(s);
            s = "";
        }
        else
            s = s + c;
    }

    tokens.append(s);

    return tokens;
}

void LCDServer::parseTokens(const QStringList &tokens, QTcpSocket *socket)
{
    //
    //  parse commands coming in from the socket
    //

    if (tokens[0] == "HALT" ||
       tokens[0] == "QUIT" ||
       tokens[0] == "SHUTDOWN")
    {
        shutDown();
    }
    else if (tokens[0] == "HELLO")
    {
        sendConnected(socket);
    }
    else if (tokens[0] == "SWITCH_TO_TIME")
    {
        switchToTime(socket);
    }
    else if (tokens[0] == "SWITCH_TO_MUSIC")
    {
        switchToMusic(tokens, socket);
    }
    else if (tokens[0] == "SWITCH_TO_VOLUME")
    {
        switchToVolume(tokens, socket);
    }
    else if (tokens[0] == "SWITCH_TO_GENERIC")
    {
        switchToGeneric(tokens, socket);
    }
    else if (tokens[0] == "SWITCH_TO_MENU")
    {
        switchToMenu(tokens, socket);
    }
    else if (tokens[0] == "SWITCH_TO_CHANNEL")
    {
        switchToChannel(tokens, socket);
    }
    else if (tokens[0] == "SWITCH_TO_NOTHING")
    {
        switchToNothing(socket);
    }
    else if (tokens[0] == "SET_VOLUME_LEVEL")
    {
        setVolumeLevel(tokens, socket);
    }
    else if (tokens[0] == "SET_GENERIC_PROGRESS")
    {
        setGenericProgress(tokens, socket);
    }
    else if (tokens[0] == "SET_MUSIC_PROGRESS")
    {
        setMusicProgress(tokens, socket);
    }
    else if (tokens[0] == "SET_MUSIC_PLAYER_PROP")
    {
        setMusicProp(tokens, socket);
    }
    else if (tokens[0] == "SET_CHANNEL_PROGRESS")
    {
        setChannelProgress(tokens, socket);
    }
    else if (tokens[0] == "UPDATE_LEDS")
    {
        updateLEDs(tokens, socket);
    }
    else if (tokens[0] == "STOP_ALL")
    {
        if (m_lcd)
            m_lcd->stopAll();
    }
    else if (tokens[0] == "RESET")
    {
        // reset lcd & reload settings
        if (m_lcd)
            m_lcd->reset();
    }
    else
    {
        QString did_not_parse = tokens.join(" ");

        if (debug_level > 0)
            LOG(VB_GENERAL, LOG_ERR, "LCDServer::failed to parse this: " +
                did_not_parse);

        sendMessage(socket, "HUH?");
    }
}

void LCDServer::shutDown()
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer:: shuting down");

    m_serverPool->disconnect();
    m_serverPool->close();
    delete m_serverPool;
    m_serverPool = nullptr;

    exit(0);
}

void LCDServer::sendMessage(QTcpSocket *where, const QString &what)
{
    QString message = what;
    message.append("\n");
    QByteArray tmp = message.toUtf8();
    where->write(tmp.constData(), tmp.length());
}

void LCDServer::sendKeyPress(const QString& key_pressed)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer:: send key press: " + key_pressed);

    // send key press to last client that sent us a message
    if (m_lastSocket)
        sendMessage(m_lastSocket, "KEY " + key_pressed);
}

void LCDServer::sendConnected(QTcpSocket *socket)
{
    QString sWidth, sHeight;
    int nWidth = 0, nHeight = 0;

    if (m_lcd)
    {
        nWidth = m_lcd->getLCDWidth();
        nHeight = m_lcd->getLCDHeight();
    }

    sWidth = sWidth.setNum(nWidth);
    sHeight = sHeight.setNum(nHeight);

    sendMessage(socket, "CONNECTED " + sWidth + " " + sHeight);
}

void LCDServer::switchToTime(QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer:: SWITCH_TO_TIME");

    if (m_lcd)
        m_lcd->switchToTime();

    sendMessage(socket, "OK");
}

void LCDServer::switchToMusic(const QStringList &tokens, QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer: SWITCH_TO_MUSIC");

    QString flat = tokens.join(" ");

    if (tokens.count() != 4)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad SWITCH_TO_MUSIC command: " + flat);
        sendMessage(socket, "HUH?");
        return;
    }

    if (m_lcd)
        m_lcd->switchToMusic(tokens[1], tokens[2], tokens[3]);

    sendMessage(socket, "OK");
}

void LCDServer::switchToGeneric(const QStringList &tokens, QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer: SWITCH_TO_GENERIC");

    QString flat = tokens.join(" ");

    if ((tokens.count() - 1) % 5 != 0)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad no. of args SWITCH_TO_GENERIC command: " + flat);
        sendMessage(socket, "HUH?");
        return;
    }

    QList<LCDTextItem> items;

    for (int x = 1; x < tokens.count(); x += 5)
    {
        bool bOK = false;
        int row = tokens[x].toInt(&bOK);
        if (!bOK)
        {
            LOG(VB_GENERAL, LOG_ERR,
                "LCDServer: bad row no. in SWITCH_TO_GENERIC "
                    "command: " + tokens[x]);
            sendMessage(socket, "HUH?");
            return;
        }

        TEXT_ALIGNMENT align = ALIGN_LEFT;
        if (tokens[x + 1] == "ALIGN_LEFT")
            align = ALIGN_LEFT;
        else if (tokens[x + 1] == "ALIGN_RIGHT")
            align = ALIGN_RIGHT;
        else if (tokens[x + 1] == "ALIGN_CENTERED")
            align = ALIGN_CENTERED;
        else
        {
            LOG(VB_GENERAL, LOG_ERR,
                "LCDServer: bad align in SWITCH_TO_GENERIC command: " +
                tokens[x + 1]);
            sendMessage(socket, "HUH?");
            return;
        }

        QString text = tokens[x + 2];
        QString screen = tokens[x + 3];
        bool scrollable = false;
        if (tokens[x + 4] == "TRUE")
            scrollable = true;
        else if (tokens[x + 4] == "FALSE")
            scrollable = false;
        else
        {
            LOG(VB_GENERAL, LOG_ERR,
                "LCDServer: bad scrollable bool in SWITCH_TO_GENERIC "
                "command: " + tokens[x + 4]);
            sendMessage(socket, "HUH?");
            return;
        }

        items.append(LCDTextItem(row, align, text, screen, scrollable));
    }

    if (m_lcd)
        m_lcd->switchToGeneric(&items);

    sendMessage(socket, "OK");
}

void LCDServer::switchToChannel(const QStringList &tokens, QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer: SWITCH_TO_CHANNEL");

    QString flat = tokens.join(" ");

    if (tokens.count() != 4)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad SWITCH_TO_CHANNEL command: " + flat);
        sendMessage(socket, "HUH?");
        return;
    }

    if (m_lcd)
        m_lcd->switchToChannel(tokens[1], tokens[2], tokens[3]);

    sendMessage(socket, "OK");
}

void LCDServer::switchToVolume(const QStringList &tokens, QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer: SWITCH_TO_VOLUME");

    QString flat = tokens.join(" ");

    if (tokens.count() != 2)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad SWITCH_TO_VOLUME command: " + flat);
        sendMessage(socket, "HUH?");
        return;
    }

    if (m_lcd)
        m_lcd->switchToVolume(tokens[1]);

    sendMessage(socket, "OK");
}

void LCDServer::switchToNothing(QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer: SWITCH_TO_NOTHING");

    if (m_lcd)
        m_lcd->switchToNothing();

    sendMessage(socket, "OK");
}

void LCDServer::switchToMenu(const QStringList &tokens, QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO,
            QString("LCDServer: SWITCH_TO_MENU: %1").arg(tokens.count()));

    QString flat = tokens.join(" ");

    if ((tokens.count() - 3) % 5 != 0)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad no. of args SWITCH_TO_MENU command: " + flat);
        sendMessage(socket, "HUH?");
        return;
    }

    QString appName = tokens[1];

    bool bPopup = false;
    if (tokens[2] == "TRUE")
        bPopup = true;
    else if (tokens[2] == "FALSE")
        bPopup = false;
    else
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad popup bool in SWITCH_TO_MENU command: " +
             tokens[2]);
        sendMessage(socket, "HUH?");
        return;
    }

    QList<LCDMenuItem> items;

    for (int x = 3; x < tokens.count(); x += 5)
    {
        QString text = tokens[x];

        CHECKED_STATE checked = CHECKED;
        if (tokens[x + 1] == "CHECKED")
            checked = CHECKED;
        else if (tokens[x + 1] == "UNCHECKED")
            checked = UNCHECKED;
        else if (tokens[x + 1] == "NOTCHECKABLE")
            checked = NOTCHECKABLE;
        else
        {
            LOG(VB_GENERAL, LOG_ERR,
                "LCDServer: bad checked state in SWITCH_TO_MENU command: " +
                tokens[x + 1]);
            sendMessage(socket, "HUH?");
            return;
        }

        bool selected = false;
        if (tokens[x + 2] == "TRUE")
            selected = true;
        else if (tokens[x + 2] == "FALSE")
            selected = false;
        else
        {
            LOG(VB_GENERAL, LOG_ERR,
                "LCDServer: bad selected state in SWITCH_TO_MENU command: " +
                tokens[x + 2]);
            sendMessage(socket, "HUH?");
            return;
        }

        bool scrollable = false;
        if (tokens[x + 3] == "TRUE")
            scrollable = true;
        else if (tokens[x + 3] == "FALSE")
            scrollable = false;
        else
        {
            LOG(VB_GENERAL, LOG_ERR,
                "LCDServer: bad scrollable bool in SWITCH_TO_MENU command: " +
                tokens[x + 3]);
            sendMessage(socket, "HUH?");
            return;
        }

        bool bOK = false;
        int indent = tokens[x + 4].toInt(&bOK);
        if (!bOK)
        {
            LOG(VB_GENERAL, LOG_ERR,
                "LCDServer: bad indent in SWITCH_TO_MENU command: " +
                tokens[x + 4]);
            sendMessage(socket, "HUH?");
            return;
        }

        items.append(LCDMenuItem(selected, checked, text, indent, scrollable));
    }

    if (m_lcd)
        m_lcd->switchToMenu(&items, appName, bPopup);

    sendMessage(socket, "OK");
}

void LCDServer::setChannelProgress(const QStringList &tokens, QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer: SET_CHANNEL_PROGRESS");

    QString flat = tokens.join(" ");

    if (tokens.count() != 3)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad SET_CHANNEL_PROGRESS command: " + flat);
        sendMessage(socket, "HUH?");
        return;
    }

    bool bOK = false;
    float progress = tokens[2].toFloat(&bOK);
    if (!bOK)
    {
        LOG(VB_GENERAL, LOG_ERR,
            QString("LCDServer: bad float value in SET_CHANNEL_PROGRESS "
                    "command: %1").arg(tokens[2]));
        sendMessage(socket, "HUH?");
        return;
    }

    if (m_lcd)
        m_lcd->setChannelProgress(tokens[1], progress);

    sendMessage(socket, "OK");
}

void LCDServer::setGenericProgress(const QStringList &tokens, QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer: SET_GENERIC_PROGRESS");

    QString flat = tokens.join(" ");

    if (tokens.count() != 3)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad SET_GENERIC_PROGRESS command: " + flat);
        sendMessage(socket, "HUH?");
        return;
    }

    bool bOK = false;
    bool busy = tokens[1].toInt(&bOK) != 0;
    if (!bOK)
    {
        LOG(VB_GENERAL, LOG_ERR,
            QString("LCDServer: bad bool value in SET_GENERIC_PROGRESS "
                    "command: %1 %2").arg(tokens[1]).arg(tokens[2]));
        sendMessage(socket, "HUH?");
        return;
    }
    float progress = tokens[2].toFloat(&bOK);
    if (!bOK)
    {
        LOG(VB_GENERAL, LOG_ERR,
            QString("LCDServer: bad float value in SET_GENERIC_PROGRESS "
                    "command: %1").arg(tokens[2]));
        sendMessage(socket, "HUH?");
        return;
    }

    if (m_lcd)
        m_lcd->setGenericProgress(busy, progress);

    sendMessage(socket, "OK");
}

void LCDServer::setMusicProgress(const QStringList &tokens, QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer: SET_MUSIC_PROGRESS");

    QString flat = tokens.join(" ");

    if (tokens.count() != 3)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad SET_MUSIC_PROGRESS command: " + flat);
        sendMessage(socket, "HUH?");
        return;
    }

    bool bOK = false;
    float progress = tokens[2].toFloat(&bOK);
    if (!bOK)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad float value in SET_MUSIC_PROGRESS command: " +
            tokens[2]);
        sendMessage(socket, "HUH?");
        return;
    }

    if (m_lcd)
        m_lcd->setMusicProgress(tokens[1], progress);

    sendMessage(socket, "OK");
}

void LCDServer::setMusicProp(const QStringList &tokens, QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer: SET_MUSIC_PROP");

    QString flat = tokens.join(" ");

    if (tokens.count() < 3)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad SET_MUSIC_PROP command: " + flat);
        sendMessage(socket, "HUH?");
        return;
    }

    if (tokens[1] == "SHUFFLE")
    {
        if (tokens.count () != 3)
        {
            LOG(VB_GENERAL, LOG_ERR,
                "LCDServer: missing argument for SET_MUSIC_PROP SHUFFLE "
                "command: " + flat);
            sendMessage(socket, "HUH?");
            return;
        }
        bool bOk = false;
        int state = tokens[2].toInt (&bOk);
        if (!bOk)
        {
            LOG(VB_GENERAL, LOG_ERR,
                "LCDServer: bad argument for SET_MUSIC_PROP SHUFFLE "
                "command: " + tokens[2]);
            sendMessage(socket, "HUH?");
            return;
        }
        if (m_lcd)
            m_lcd->setMusicShuffle (state);
    }
    else if (tokens[1] == "REPEAT")
    {
        if (tokens.count () != 3)
        {
            LOG(VB_GENERAL, LOG_ERR,
                "LCDServer: missing argument for SET_MUSIC_PROP REPEAT "
                "command: " + flat);
            sendMessage(socket, "HUH?");
            return;
        }
        bool bOk = false;
        int state = tokens[2].toInt (&bOk);
        if (!bOk)
        {
            LOG(VB_GENERAL, LOG_ERR,
                "LCDServer: bad argument for SET_MUSIC_PROP REPEAT command: " +
                tokens[2]);
            sendMessage(socket, "HUH?");
            return;
        }
        if (m_lcd)
            m_lcd->setMusicRepeat (state);
    }
    else
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad argument for SET_MUSIC_PROP command: " + tokens[1]);
        sendMessage(socket, "HUH?");
        return;
    }

    sendMessage(socket, "OK");
}

void LCDServer::setVolumeLevel(const QStringList &tokens, QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer: SET_VOLUME_LEVEL");

    QString flat = tokens.join(" ");

    if (tokens.count() != 2)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad SET_VOLUME_LEVEL command: " + flat);
        sendMessage(socket, "HUH?");
        return;
    }

    bool bOK = false;
    float progress = tokens[1].toFloat(&bOK);
    if (!bOK)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad float value in SET_VOLUME_LEVEL command: " +
            tokens[1]);
        sendMessage(socket, "HUH?");
        return;
    }

    if (m_lcd)
        m_lcd->setVolumeLevel(progress);

    sendMessage(socket, "OK");
}

void LCDServer::updateLEDs(const QStringList &tokens, QTcpSocket *socket)
{
    if (debug_level > 0)
        LOG(VB_GENERAL, LOG_INFO, "LCDServer: UPDATE_LEDS");

    QString flat = tokens.join(" ");

    if (tokens.count() != 2)
    {
        LOG(VB_GENERAL, LOG_ERR, "LCDServer: bad UPDATE_LEDs command: " + flat);
        sendMessage(socket, "HUH?");
        return;
    }

    bool bOK = false;
    int mask = tokens[1].toInt(&bOK);
    if (!bOK)
    {
        LOG(VB_GENERAL, LOG_ERR,
            "LCDServer: bad mask in UPDATE_LEDS command: " + tokens[1]);
        sendMessage(socket, "HUH?");
        return;
    }

    if (m_lcd)
        m_lcd->updateLEDs(mask);

    sendMessage(socket, "OK");
}