mythnews.cpp

Go to the documentation of this file.

// POSIX headers
#include <unistd.h>
 
// C headers
#include <algorithm>
#include <cmath>
 
// QT headers
#include <QCoreApplication>
#include <QDateTime>
#include <QDir>
#include <QRegularExpression>
#include <QTimer>
#include <QUrl>
 
// MythTV headers
#include <libmythbase/mythcorecontext.h>
#include <libmythbase/mythdate.h>
#include <libmythbase/mythdb.h>
#include <libmythbase/mythdirs.h>
#include <libmythbase/mythdownloadmanager.h>
#include <libmythbase/mythlogging.h>
#include <libmythbase/mythsystemlegacy.h>
#include <libmythui/mythdialogbox.h>
#include <libmythui/mythmainwindow.h>
#include <libmythui/mythuibuttonlist.h>
#include <libmythui/mythuiimage.h>
#include <libmythui/mythuitext.h>
 
// MythNews headers
#include "mythnews.h"
#include "mythnewsconfig.h"
#include "mythnewseditor.h"
#include "newsdbutil.h"
 
#define LOC      QString("MythNews: ")
#define LOC_WARN QString("MythNews, Warning: ")
#define LOC_ERR  QString("MythNews, Error: ")
 
MythNews::MythNews(MythScreenStack *parent, const QString &name) :
    MythScreenType(parent, name),
    m_retrieveTimer(new QTimer(this)),
    m_updateFreq(gCoreContext->GetDurSetting<std::chrono::minutes>("NewsUpdateFrequency", 30min)),
    m_zoom(gCoreContext->GetSetting("WebBrowserZoomLevel", "1.0")),
    m_browser(gCoreContext->GetSetting("WebBrowserCommand", ""))
{
    // Setup cache directory
 
    QString fileprefix = GetConfDir();
 
    QDir dir(fileprefix);
    if (!dir.exists())
        dir.mkdir(fileprefix);
    fileprefix += "/MythNews";
    dir.setPath(fileprefix);;
    if (!dir.exists())
        dir.mkdir(fileprefix);
 
    connect(m_retrieveTimer, &QTimer::timeout,
            this, &MythNews::slotRetrieveNews);
 
    m_retrieveTimer->stop();
    m_retrieveTimer->setSingleShot(false);
    m_retrieveTimer->start(m_timerTimeout);
}
 
MythNews::~MythNews()
{
    QMutexLocker locker(&m_lock);
}
 
bool MythNews::Create(void)
{
    QMutexLocker locker(&m_lock);
 
    // Load the theme for this screen
    bool foundtheme = LoadWindowFromXML("news-ui.xml", "news", this);
    if (!foundtheme)
        return false;
 
    bool err = false;
    UIUtilE::Assign(this, m_sitesList, "siteslist", &err);
    UIUtilE::Assign(this, m_articlesList, "articleslist", &err);
    UIUtilE::Assign(this, m_titleText, "title", &err);
    UIUtilE::Assign(this, m_descText, "description", &err);
 
    // these are all optional
    UIUtilW::Assign(this, m_nositesText, "nosites", &err);
    UIUtilW::Assign(this, m_updatedText, "updated", &err);
    UIUtilW::Assign(this, m_thumbnailImage, "thumbnail", &err);
    UIUtilW::Assign(this, m_enclosureImage, "enclosures", &err);
    UIUtilW::Assign(this, m_downloadImage, "download", &err);
    UIUtilW::Assign(this, m_podcastImage, "ispodcast", &err);
 
    if (err)
    {
        LOG(VB_GENERAL, LOG_ERR, "Cannot load screen 'news'");
        return false;
    }
 
    if (m_nositesText)
    {
        m_nositesText->SetText(tr("You haven't configured MythNews to use any sites."));
        m_nositesText->Hide();
    }
 
    BuildFocusList();
 
    SetFocusWidget(m_sitesList);
 
    loadSites();
    updateInfoView(m_sitesList->GetItemFirst());
 
    connect(m_sitesList, &MythUIButtonList::itemSelected,
            this, &MythNews::slotSiteSelected);
    connect(m_articlesList, &MythUIButtonList::itemSelected,
            this, qOverload<MythUIButtonListItem *>(&MythNews::updateInfoView));
    connect(m_articlesList, &MythUIButtonList::itemClicked,
            this, &MythNews::slotViewArticle);
 
    return true;
}
 
void MythNews::clearSites(void)
{
    m_newsSites.clear();
    m_sitesList->Reset();
    m_articles.clear();
    m_articlesList->Reset();
 
    m_titleText->Reset();
    m_descText->Reset();
 
    if (m_updatedText)
        m_updatedText->Reset();
 
    if (m_downloadImage)
        m_downloadImage->Hide();
 
    if (m_enclosureImage)
        m_enclosureImage->Hide();
 
    if (m_podcastImage)
        m_podcastImage->Hide();
 
    if (m_thumbnailImage)
        m_thumbnailImage->Hide();
}
 
void MythNews::loadSites(void)
{
    QMutexLocker locker(&m_lock);
 
    clearSites();
 
    MSqlQuery query(MSqlQuery::InitCon());
    query.prepare(
        "SELECT name, url, ico, updated, podcast "
        "FROM newssites "
        "ORDER BY name");
 
    if (!query.exec())
    {
        MythDB::DBError(LOC_ERR + "Could not load sites from DB", query);
        return;
    }
 
    while (query.next())
    {
        QString name = query.value(0).toString();
        QString url  = query.value(1).toString();
//      QString icon = query.value(2).toString();
        QDateTime time = MythDate::fromSecsSinceEpoch(query.value(3).toLongLong());
        bool podcast = query.value(4).toBool();
        m_newsSites.push_back(new NewsSite(name, url, time, podcast));
    }
    std::ranges::sort(m_newsSites, NewsSite::sortByName);
 
    for (auto & site : m_newsSites)
    {
        auto *item = new MythUIButtonListItem(m_sitesList, site->name());
        item->SetData(QVariant::fromValue(site));
 
        connect(site, &NewsSite::finished,
                this, &MythNews::slotNewsRetrieved);
    }
 
    slotRetrieveNews();
 
    if (m_nositesText)
    {
        if (m_newsSites.empty())
            m_nositesText->Show();
        else
            m_nositesText->Hide();
    }
}
 
void MythNews::updateInfoView(MythUIButtonListItem *selected)
{
    QMutexLocker locker(&m_lock);
 
    if (!selected)
        return;
 
    NewsSite *site = nullptr;
    NewsArticle article;
 
    if (GetFocusWidget() == m_articlesList)
    {
        article = m_articles[selected];
        if (m_sitesList->GetItemCurrent())
            site = m_sitesList->GetItemCurrent()->GetData().value<NewsSite*>();
    }
    else
    {
        site = selected->GetData().value<NewsSite*>();
        if (m_articlesList->GetItemCurrent())
            article = m_articles[m_articlesList->GetItemCurrent()];
    }
 
    if (GetFocusWidget() == m_articlesList)
    {
        if (!article.title().isEmpty())
        {
 
            if (m_titleText)
            {
                QString title = cleanText(article.title());
                m_titleText->SetText(title);
            }
 
            if (m_descText)
            {
                QString artText = cleanText(article.description());
                m_descText->SetText(artText);
            }
 
            if (!article.thumbnail().isEmpty())
            {
                if (m_thumbnailImage)
                {
                    m_thumbnailImage->SetFilename(article.thumbnail());
                    m_thumbnailImage->Load();
 
                    if (!m_thumbnailImage->IsVisible())
                        m_thumbnailImage->Show();
                }
            }
            else
            {
                if (site && !site->imageURL().isEmpty())
                {
                    if (m_thumbnailImage)
                    {
                        m_thumbnailImage->SetFilename(site->imageURL());
                        m_thumbnailImage->Load();
 
                        if (!m_thumbnailImage->IsVisible())
                            m_thumbnailImage->Show();
                    }
                }
                else
                {
                    if (m_thumbnailImage)
                        m_thumbnailImage->Hide();
                }
            }
 
            if (m_downloadImage)
            {
                if (!article.enclosure().isEmpty())
                {
                    if (!m_downloadImage->IsVisible())
                        m_downloadImage->Show();
                }
                else
                {
                    m_downloadImage->Hide();
                }
            }
 
            if (m_enclosureImage)
            {
                if (!article.enclosure().isEmpty())
                {
                    if (!m_enclosureImage->IsVisible())
                        m_enclosureImage->Show();
                }
                else
                {
                    m_enclosureImage->Hide();
                }
            }
 
            if (m_podcastImage)
                m_podcastImage->Hide();
        }
    }
    else
    {
        if (m_downloadImage)
            m_downloadImage->Hide();
 
        if (m_enclosureImage)
            m_enclosureImage->Hide();
 
        if (m_podcastImage)
            m_podcastImage->Hide();
 
        if (site)
        {
            if (m_titleText)
                m_titleText->SetText(site->name());
 
            if (m_descText)
                m_descText->SetText(site->description());
 
            if (m_thumbnailImage && m_thumbnailImage->IsVisible())
                m_thumbnailImage->Hide();
 
            if (m_podcastImage && site->podcast())
                m_podcastImage->Show();
 
            if (!site->imageURL().isEmpty())
            {
                if (m_thumbnailImage)
                {
                    m_thumbnailImage->SetFilename(site->imageURL());
                    m_thumbnailImage->Load();
 
                    if (!m_thumbnailImage->IsVisible())
                        m_thumbnailImage->Show();
                }
            }
        }
    }
 
    if (m_updatedText)
    {
 
        if (site)
        {
            QString text(tr("Updated") + " - ");
            QDateTime updated(site->lastUpdated());
            if (updated.isValid()) {
                text += MythDate::toString(site->lastUpdated(),
                                           MythDate::kDateTimeFull | MythDate::kSimplify);
            }
            else
            {
                text += tr("Unknown");
            }
            m_updatedText->SetText(text);
        }
    }
}
 
bool MythNews::keyPressEvent(QKeyEvent *event)
{
    if (GetFocusWidget() && GetFocusWidget()->keyPressEvent(event))
        return true;
 
    QStringList actions;
    bool handled = GetMythMainWindow()->TranslateKeyPress("News", event, actions);
 
    for (int i = 0; i < actions.size() && !handled; i++)
    {
        const QString& action = actions[i];
        handled = true;
 
        if (action == "RETRIEVENEWS")
            slotRetrieveNews();
        else if (action == "CANCEL")
            cancelRetrieve();
        else if (action == "MENU")
            ShowMenu();
        else if (action == "EDIT")
            ShowEditDialog(true);
        else if (action == "DELETE")
            deleteNewsSite();
        else
            handled = false;
    }
 
    if (!handled && MythScreenType::keyPressEvent(event))
        handled = true;
 
    return handled;
}
 
void MythNews::slotRetrieveNews(void)
{
    QMutexLocker locker(&m_lock);
 
    if (m_newsSites.empty())
        return;
 
    m_retrieveTimer->stop();
 
    for (auto & site : m_newsSites)
    {
        if (site->timeSinceLastUpdate() > m_updateFreq)
            site->retrieve();
        else
            processAndShowNews(site);
    }
 
    m_retrieveTimer->stop();
    m_retrieveTimer->setSingleShot(false);
    m_retrieveTimer->start(m_timerTimeout);
}
 
void MythNews::slotNewsRetrieved(NewsSite *site)
{
    qint64 updated = site->lastUpdated().toSecsSinceEpoch();
 
    MSqlQuery query(MSqlQuery::InitCon());
    query.prepare("UPDATE newssites SET updated = :UPDATED "
                  "WHERE name = :NAME ;");
    query.bindValue(":UPDATED", updated);
    query.bindValue(":NAME", site->name());
    if (!query.exec() || !query.isActive())
        MythDB::DBError("news update time", query);
 
    processAndShowNews(site);
}
 
void MythNews::cancelRetrieve(void)
{
    QMutexLocker locker(&m_lock);
 
    for (auto & site : m_newsSites)
    {
        site->stop();
        processAndShowNews(site);
    }
}
 
void MythNews::processAndShowNews(NewsSite *site)
{
    QMutexLocker locker(&m_lock);
 
    if (!site)
        return;
 
    site->process();
 
    MythUIButtonListItem *siteUIItem = m_sitesList->GetItemCurrent();
    if (!siteUIItem)
        return;
 
    if (site != siteUIItem->GetData().value<NewsSite*>())
        return;
 
    QString currItem = m_articlesList->GetValue();
    int topPos = m_articlesList->GetTopItemPos();
 
    m_articlesList->Reset();
    m_articles.clear();
 
    NewsArticle::List articles = site->GetArticleList();
    for (auto & article : articles)
    {
        auto *item =
            new MythUIButtonListItem(m_articlesList, cleanText(article.title()));
        m_articles[item] = article;
    }
 
    if (m_articlesList->MoveToNamedPosition(currItem))
        m_articlesList->SetItemCurrent(m_articlesList->GetCurrentPos(), topPos);
}
 
void MythNews::slotSiteSelected(MythUIButtonListItem *item)
{
    QMutexLocker locker(&m_lock);
 
    if (!item || item->GetData().isNull())
        return;
 
    auto *site = item->GetData().value<NewsSite*>();
    if (!site)
        return;
 
    m_articlesList->Reset();
    m_articles.clear();
 
    NewsArticle::List articles = site->GetArticleList();
    for (auto & article : articles)
    {
        auto *blitem = new MythUIButtonListItem(m_articlesList, cleanText(article.title()));
        m_articles[blitem] = article;
    }
 
    updateInfoView(item);
}
 
void MythNews::slotViewArticle(MythUIButtonListItem *articlesListItem)
{
    QMutexLocker locker(&m_lock);
 
    QMap<MythUIButtonListItem*,NewsArticle>::const_iterator it =
        m_articles.constFind(articlesListItem);
 
    if (it == m_articles.constEnd())
        return;
 
    const NewsArticle& article = *it;
 
    if (article.articleURL().isEmpty())
        return;
 
    if (article.enclosure().isEmpty())
    {
        QString cmdUrl(article.articleURL());
 
        if (m_browser.isEmpty())
        {
            ShowOkPopup(tr("No browser command set! MythNews needs MythBrowser to be installed."));
            return;
        }
 
        // display the web page
        if (m_browser.toLower() == "internal")
        {
            GetMythMainWindow()->HandleMedia("WebBrowser", cmdUrl);
            return;
        }
 
        QString cmd = m_browser;
        cmd.replace("%ZOOM%", m_zoom);
        cmd.replace("%URL%", cmdUrl);
        cmd.replace('\'', "%27");
        cmd.replace("&","\\&");
        cmd.replace(";","\\;");
 
        GetMythMainWindow()->AllowInput(false);
        myth_system(cmd, kMSDontDisableDrawing);
        GetMythMainWindow()->AllowInput(true);
        return;
    }
 
    playVideo(article);
}
 
void MythNews::ShowEditDialog(bool edit)
{
    QMutexLocker locker(&m_lock);
 
    NewsSite *site = nullptr;
 
    if (edit)
    {
        MythUIButtonListItem *siteListItem = m_sitesList->GetItemCurrent();
 
        if (!siteListItem || siteListItem->GetData().isNull())
            return;
 
        site = siteListItem->GetData().value<NewsSite*>();
    }
 
    MythScreenStack *mainStack = GetMythMainWindow()->GetMainStack();
 
    auto *mythnewseditor = new MythNewsEditor(site, edit, mainStack,
                                              "mythnewseditor");
 
    if (mythnewseditor->Create())
    {
        connect(mythnewseditor, &MythScreenType::Exiting, this, &MythNews::loadSites);
        mainStack->AddScreen(mythnewseditor);
    }
    else
    {
        delete mythnewseditor;
    }
}
 
void MythNews::ShowFeedManager() const
{
    MythScreenStack *mainStack = GetMythMainWindow()->GetMainStack();
 
    auto *mythnewsconfig = new MythNewsConfig(mainStack, "mythnewsconfig");
 
    if (mythnewsconfig->Create())
    {
        connect(mythnewsconfig, &MythScreenType::Exiting, this, &MythNews::loadSites);
        mainStack->AddScreen(mythnewsconfig);
    }
    else
    {
        delete mythnewsconfig;
    }
}
 
void MythNews::ShowMenu(void)
{
    QMutexLocker locker(&m_lock);
 
    QString label = tr("Options");
 
    MythScreenStack *popupStack =
                            GetMythMainWindow()->GetStack("popup stack");
 
    m_menuPopup = new MythDialogBox(label, popupStack, "mythnewsmenupopup");
 
    if (m_menuPopup->Create())
    {
        popupStack->AddScreen(m_menuPopup);
 
        m_menuPopup->SetReturnEvent(this, "options");
 
        m_menuPopup->AddButton(tr("Manage Feeds"));
        m_menuPopup->AddButton(tr("Add Feed"));
        if (!m_newsSites.empty())
        {
            m_menuPopup->AddButton(tr("Edit Feed"));
            m_menuPopup->AddButton(tr("Delete Feed"));
        }
    }
    else
    {
        delete m_menuPopup;
        m_menuPopup = nullptr;
    }
}
 
void MythNews::deleteNewsSite(void)
{
    QMutexLocker locker(&m_lock);
 
    MythUIButtonListItem *siteUIItem = m_sitesList->GetItemCurrent();
 
    if (siteUIItem && !siteUIItem->GetData().isNull())
    {
        auto *site = siteUIItem->GetData().value<NewsSite*>();
        if (site)
        {
            removeFromDB(site->name());
            loadSites();
        }
    }
}
 
// does not need locking
void MythNews::playVideo(const NewsArticle &article)
{
    GetMythMainWindow()->HandleMedia("Internal", article.enclosure(),
                                     article.description(), article.title());
}
 
// does not need locking
void MythNews::customEvent(QEvent *event)
{
    if (event->type() == DialogCompletionEvent::kEventType)
    {
        auto *dce = dynamic_cast<DialogCompletionEvent*>(event);
        if (dce == nullptr)
            return;
 
        QString resultid  = dce->GetId();
        int     buttonnum = dce->GetResult();
 
        if (resultid == "options")
        {
            if (buttonnum == 0)
                ShowFeedManager();
            else if (buttonnum == 1)
                ShowEditDialog(false);
            else if (buttonnum == 2)
                ShowEditDialog(true);
            else if (buttonnum == 3)
                deleteNewsSite();
        }
 
        m_menuPopup = nullptr;
    }
}
 
QString MythNews::cleanText(const QString &text)
{
    QString result = text;
 
    // replace a few HTML characters
    result.replace("&#8232;", "");   // LSEP
    result.replace("&#8233;", "");   // PSEP
    result.replace("&#163;",  "£");  // POUND
    result.replace("&#173;",  "");   // ?
    result.replace("&#8211;", "-");  // EN-DASH
    result.replace("&#8220;", """"); // LEFT-DOUBLE-QUOTE
    result.replace("&#8221;", """"); // RIGHT-DOUBLE-QUOTE
    result.replace("&#8216;", "'");  // LEFT-SINGLE-QUOTE
    result.replace("&#8217;", "'");  // RIGHT-SINGLE-QUOTE
    result.replace("&#39;", "'");    // Apostrophe
 
    // Replace paragraph and break HTML with newlines
    static const QRegularExpression kHtmlParaStartRE
        { "<p>", QRegularExpression::CaseInsensitiveOption };
    static const QRegularExpression kHtmlParaEndRE
        { "</p>", QRegularExpression::CaseInsensitiveOption };
    static const QRegularExpression kHtmlBreak1RE
        { "<(br|)>", QRegularExpression::CaseInsensitiveOption };
    static const QRegularExpression kHtmlBreak2RE
        { "<(br|)/>", QRegularExpression::CaseInsensitiveOption };
    if( result.contains(kHtmlParaEndRE) )
    {
        result.replace( kHtmlParaStartRE, "");
        result.replace( kHtmlParaEndRE, "\n\n");
    }
    else
    {
        result.replace( kHtmlParaStartRE, "\n\n");
        result.replace( kHtmlParaEndRE, "");
    }
    result.replace( kHtmlBreak2RE, "\n");
    result.replace( kHtmlBreak1RE, "\n");
    // These are done instead of simplifyWhitespace
    // because that function also strips out newlines
    // Replace tab characters with nothing
    static const QRegularExpression kTabRE { "\t" };
    result.replace( kTabRE, "");
    // Replace double space with single
    static const QRegularExpression kTwoSpaceRE { "  " };
    result.replace( kTwoSpaceRE, "");
    // Replace whitespace at beginning of lines with newline
    static const QRegularExpression kStartingSpaceRE { "\n " };
    result.replace( kStartingSpaceRE, "\n");
    // Remove any remaining HTML tags
    static const QRegularExpression kRemoveHtmlRE(QRegularExpression("</?.+>"));
    result.remove(kRemoveHtmlRE);
    result = result.trimmed();
 
    return result;
}