mythsystemevent.cpp

Go to the documentation of this file.

#include <QApplication>
#include <QFileInfo>
#include <QRunnable>
#include <utility>

#include "mythcorecontext.h"
#include "mthreadpool.h"
#include "mythsystemlegacy.h"
#include "mythsystemevent.h"
#include "programinfo.h"
#include "cardutil.h"
#include "remoteutil.h"
#include "exitcodes.h"
#include "mythlogging.h"

#define LOC      QString("MythSystemEventHandler: ")

class SystemEventThread : public QRunnable
{
  public:
    explicit SystemEventThread(QString cmd, QString eventName = "")
      : m_command(std::move(cmd)), m_event(std::move(eventName)) {};

    void run(void) override // QRunnable
    {
        uint flags = kMSDontBlockInputDevs;
        uint result = myth_system(m_command, flags);

        LOG(VB_GENERAL,
            (result == GENERIC_EXIT_OK ? LOG_INFO : LOG_WARNING), LOC +
            QString("Finished '%1' result %2")
            .arg(m_command).arg(result));

        if (m_event.isEmpty())
            return;

        gCoreContext->SendMessage(
            QString("SYSTEM_EVENT_RESULT %1 SENDER %2 RESULT %3")
                    .arg(m_event).arg(gCoreContext->GetHostName()).arg(result));
    }

  private:
    // Private data storage
    QString m_command;
    QString m_event;
};


MythSystemEventHandler::MythSystemEventHandler(void)
{
    setObjectName("MythSystemEventHandler");
    gCoreContext->addListener(this);
}

MythSystemEventHandler::~MythSystemEventHandler()
{
    gCoreContext->removeListener(this);
}

void MythSystemEventHandler::SubstituteMatches(const QStringList &tokens,
                                               QString &command)
{
    if (command.isEmpty())
        return;

    LOG(VB_FILE, LOG_DEBUG, LOC + QString("SubstituteMatches: BEFORE: %1")
                                            .arg(command));
    QString args;
    uint chanid = 0;
    QDateTime recstartts;
    QString sender;

    QStringList::const_iterator it = tokens.begin();
    ++it;
    command.replace(QString("%EVENTNAME%"), *it);

    ++it;
    while (it != tokens.end())
    {
        if (!args.isEmpty())
            args += " ";
        args += *it;

        // Check for some token names that we substitute one for one as
        // %MATCH% type variables.
        if ((*it == "CARDID") ||
            (*it == "COMMAND") ||
            (*it == "RECSTATUS") ||
            (*it == "HOSTNAME") ||
            (*it == "SECS") ||
            (*it == "SENDER") ||
            (*it == "PATH") ||
            (*it == "VIDEODEVICE") ||
            (*it == "VBIDEVICE"))
        {
            QString token = *it;

            if (++it == tokens.end())
                break;

            if (token == "SENDER")
                sender = *it;

            // The following string is broken up on purpose to indicate
            // what we're replacing is the token surrounded by percent signs
            command.replace(QString("%" "%1" "%").arg(token), *it);

            if (!args.isEmpty())
                args += " ";
            args += *it;
        }

        // Remember any chanid and starttime so we can lookup info about
        // the recording from the database.
        if (*it == "CHANID")
        {
            if (++it == tokens.end())
                break;

            chanid = (*it).toUInt();

            if (!args.isEmpty())
                args += " ";
            args += *it;
        }

        if (*it == "STARTTIME")
        {
            if (++it == tokens.end())
                break;

            recstartts = MythDate::fromString(*it);

            if (!args.isEmpty())
                args += " ";
            args += *it;
        }

        ++it;
    }

    command.replace(QString("%ARGS%"), args);

    // 1st, try loading RecordingInfo / ProgramInfo
    RecordingInfo recinfo(chanid, recstartts);
    bool loaded = recinfo.GetChanID();
    if (loaded)
        recinfo.SubstituteMatches(command);
    else
    {
        // 2rd Try searching for RecordingInfo
        RecordingInfo::LoadStatus status = RecordingInfo::kNoProgram;
        RecordingInfo recinfo2(chanid, recstartts, false, 0, &status);
        if (status == RecordingInfo::kFoundProgram)
            recinfo2.SubstituteMatches(command);
        else
        {
            // 3th just use what we know
            command.replace(QString("%CHANID%"), QString::number(chanid));
            command.replace(QString("%STARTTIME%"),
                            MythDate::toString(recstartts,
                                               MythDate::kFilename));
            command.replace(QString("%STARTTIMEISO%"),
                            recstartts.toString(Qt::ISODate));
        }
    }

    command.replace(QString("%VERBOSELEVEL%"), QString("%1").arg(verboseMask));
    command.replace("%VERBOSEMODE%", QString("%1").arg(logPropagateArgs));

    LOG(VB_FILE, LOG_DEBUG, LOC + QString("SubstituteMatches: AFTER : %1")
                                            .arg(command));
}

QString MythSystemEventHandler::EventNameToSetting(const QString &name)
{
    QString result("EventCmd");
    QStringList parts = name.toLower().split('_', QString::SkipEmptyParts);

    QStringList::Iterator it = parts.begin();
    while (it != parts.end())
    {
        result += (*it).left(1).toUpper();
        result += (*it).mid(1);

        ++it;
    }

    return result;
}

void MythSystemEventHandler::customEvent(QEvent *e)
{
    if (e->type() == MythEvent::MythEventMessage)
    {
        auto *me = dynamic_cast<MythEvent *>(e);
        if (me == nullptr)
            return;
        QString msg = me->Message().simplified();

        if (msg == "CLEAR_SETTINGS_CACHE")
            msg = "SYSTEM_EVENT SETTINGS_CACHE_CLEARED";

        // Listen for any GLOBAL_SYSTEM_EVENT messages and resend to
        // the master backend as regular SYSTEM_EVENT messages.
        if (msg.startsWith("GLOBAL_SYSTEM_EVENT "))
        {
            gCoreContext->SendMessage(msg.mid(7) +
                QString(" SENDER %1").arg(gCoreContext->GetHostName()));
            return;
        }

        if ((!msg.startsWith("SYSTEM_EVENT ")) &&
            (!msg.startsWith("LOCAL_SYSTEM_EVENT ")))
            return;

        QStringList tokens = msg.split(' ', QString::SkipEmptyParts);

        // Return if this event is for another host
        if ((tokens.size() >= 4) &&
            (tokens[2] == "HOST") &&
            (tokens[3] != gCoreContext->GetHostName()))
            return;

        QString cmd;

        // See if this system has a command that runs for all system events
        cmd = gCoreContext->GetSetting("EventCmdAll");
        if (!cmd.isEmpty())
        {
            SubstituteMatches(tokens, cmd);

            auto *eventThread = new SystemEventThread(cmd);
            MThreadPool::globalInstance()->startReserved(
                eventThread, "SystemEvent");
        }

        // Check for an EventCmd for this particular event
        cmd = gCoreContext->GetSetting(EventNameToSetting(tokens[1]));
        if (!cmd.isEmpty())
        {
            SubstituteMatches(tokens, cmd);

            LOG(VB_GENERAL, LOG_INFO, LOC +
                QString("Starting thread for command '%1'").arg(cmd));

            auto *eventThread = new SystemEventThread(cmd, tokens[1]);
            MThreadPool::globalInstance()->startReserved(
                eventThread, "SystemEvent");
        }
    }
}

/****************************************************************************/

void SendMythSystemRecEvent(const QString &msg, const RecordingInfo *pginfo)
{
    if (pginfo)
    {
        uint cardid = pginfo->GetInputID();
        gCoreContext->SendSystemEvent(
            QString("%1 CARDID %2 CHANID %3 STARTTIME %4 RECSTATUS %5 "
                    "VIDEODEVICE %6 VBIDEVICE %7")
            .arg(msg).arg(cardid)
            .arg(pginfo->GetChanID())
            .arg(pginfo->GetRecordingStartTime(MythDate::ISODate))
            .arg(pginfo->GetRecordingStatus())
            .arg(CardUtil::GetVideoDevice(cardid))
            .arg(CardUtil::GetVBIDevice(cardid)));
    }
    else
    {
        LOG(VB_GENERAL, LOG_ERR, LOC +
            "SendMythSystemRecEvent() called with empty RecordingInfo");
    }
}

void SendMythSystemPlayEvent(const QString &msg, const ProgramInfo *pginfo)
{
    if (pginfo)
    {
        gCoreContext->SendSystemEvent(
            QString("%1 HOSTNAME %2 CHANID %3 STARTTIME %4")
                    .arg(msg).arg(gCoreContext->GetHostName())
                    .arg(pginfo->GetChanID())
                    .arg(pginfo->GetRecordingStartTime(MythDate::ISODate)));
    }
    else
    {
        LOG(VB_GENERAL, LOG_ERR, LOC + "SendMythSystemPlayEvent() called with "
                                       "empty ProgramInfo");
    }
}

/****************************************************************************/

MythSystemEventEditor::MythSystemEventEditor(MythScreenStack *parent,
                                             const char *name)
  : RawSettingsEditor(parent, name)
{
    m_title = tr("System Event Command Editor");

    // Event names are programmatically converted to settings names in
    // EventNameToSetting().  For convenience of searching the code
    // base, the event names are listed in comments.
    m_settings["EventCmdRecPending"]           = // REC_PENDING
        tr("Recording pending");
    m_settings["EventCmdRecPreFail"]           = // REC_PREFAIL
        tr("Recording about to fail");
    m_settings["EventCmdRecFailing"]           = // REC_FAILING
        tr("Recording failing");
    m_settings["EventCmdRecStarted"]           = // REC_STARTED
        tr("Recording started");
    m_settings["EventCmdRecStartedWriting"]    = // REC_STARTED_WRITING
        tr("Recording started writing");
    m_settings["EventCmdRecFinished"]          = // REC_FINISHED
        tr("Recording finished");
    m_settings["EventCmdRecDeleted"]           = // REC_DELETED
        tr("Recording deleted");
    m_settings["EventCmdRecExpired"]           = // REC_EXPIRED
        tr("Recording expired");
    m_settings["EventCmdLivetvStarted"]        = // LIVETV_STARTED
        tr("LiveTV started");
    m_settings["EventCmdLivetvEnded"]          = // LIVETV_ENDED
        tr("LiveTV ended");
    m_settings["EventCmdPlayStarted"]          = // PLAY_STARTED
        tr("Playback started");
    m_settings["EventCmdPlayStopped"]          = // PLAY_STOPPED
        tr("Playback stopped");
    m_settings["EventCmdPlayPaused"]           = // PLAY_PAUSED
        tr("Playback paused");
    m_settings["EventCmdPlayUnpaused"]         = // PLAY_UNPAUSED
        tr("Playback unpaused");
    m_settings["EventCmdPlayChanged"]          = // PLAY_CHANGED
        tr("Playback program changed");
    m_settings["EventCmdTuningSignalTimeout"]  = // TUNING_SIGNAL_TIMEOUT
        tr("Tuning signal waiting");
    m_settings["EventCmdMasterStarted"]        = // MASTER_STARTED
        tr("Master backend started");
    m_settings["EventCmdMasterShutdown"]       = // MASTER_SHUTDOWN
        tr("Master backend shutdown");
    m_settings["EventCmdClientConnected"]      = // CLIENT_CONNECTED
        tr("Client connected to master backend");
    m_settings["EventCmdClientDisconnected"]   = // CLIENT_DISCONNECTED
        tr("Client disconnected from master backend");
    m_settings["EventCmdSlaveConnected"]       = // SLAVE_CONNECTED
        tr("Slave backend connected to master");
    m_settings["EventCmdSlaveDisconnected"]    = // SLAVE_DISCONNECTED
        tr("Slave backend disconnected from master");
    m_settings["EventCmdNetCtrlConnected"]     = // NET_CTRL_CONNECTED
        tr("Network Control client connected");
    m_settings["EventCmdNetCtrlDisconnected"]  = // NET_CTRL_DISCONNECTED
        tr("Network Control client disconnected");
    m_settings["EventCmdMythfilldatabaseRan"]  = // MYTHFILLDATABASE_RAN
        tr("mythfilldatabase ran");
    m_settings["EventCmdSchedulerRan"]         = // SCHEDULER_RAN
        tr("Scheduler ran");
    m_settings["EventCmdSettingsCacheCleared"] = // SETTINGS_CACHE_CLEARED
        tr("Settings cache cleared");
    m_settings["EventCmdScreenType"]           = // SCREEN_TYPE
        tr("Screen created or destroyed");
    m_settings["EventCmdKey01"]                = // KEY_%1
        tr("Keystroke event #1");
    m_settings["EventCmdKey02"]                = // KEY_%1
        tr("Keystroke event #2");
    m_settings["EventCmdKey03"]                = // KEY_%1
        tr("Keystroke event #3");
    m_settings["EventCmdKey04"]                = // KEY_%1
        tr("Keystroke event #4");
    m_settings["EventCmdKey05"]                = // KEY_%1
        tr("Keystroke event #5");
    m_settings["EventCmdKey06"]                = // KEY_%1
        tr("Keystroke event #6");
    m_settings["EventCmdKey07"]                = // KEY_%1
        tr("Keystroke event #7");
    m_settings["EventCmdKey08"]                = // KEY_%1
        tr("Keystroke event #8");
    m_settings["EventCmdKey09"]                = // KEY_%1
        tr("Keystroke event #9");
    m_settings["EventCmdKey10"]                = // KEY_%1
        tr("Keystroke event #10");
    m_settings["EventCmdCecCommandReceived"]   = // CEC_COMMAND_RECEIVED
        tr("CEC command received");
    m_settings["EventCmdAll"]                  = // EventCmdAll
        tr("Any event");
}

/* vim: set expandtab tabstop=4 shiftwidth=4: */