ostinato/client/logswindow.cpp

/*
Copyright (C) 2018 Srivats P.

This file is part of "Ostinato"

This is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

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

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>
*/

#include "logswindow.h"

#include "logsmodel.h"
#include "modeltest.h"

#include <QDockWidget>
#include <QHeaderView>
#include <QMainWindow>
#include <QMovie>
#include <QPropertyAnimation>

extern QMainWindow *mainWindow;

LogsWindow::LogsWindow(LogsModel *model, QWidget *parent)
    : QWidget(parent)
{
    setupUi(this);
    logs->setModel(model);
    autoScroll->setChecked(true);

    logs->verticalHeader()->setHighlightSections(false);
    logs->verticalHeader()->setDefaultSectionSize(
            logs->verticalHeader()->minimumSectionSize());
    logs->setShowGrid(false);
    logs->setAlternatingRowColors(true);
    logs->horizontalHeader()->setSectionResizeMode(3, QHeaderView::Stretch);

    parentDock_ = qobject_cast<QDockWidget*>(parent);
    windowTitle_ = parentDock_->windowTitle();

    warnAnime_ = new QMovie(":/icons/anime_warn.gif", QByteArray(), this);
    errorAnime_ = new QMovie(":/icons/anime_error.gif", QByteArray(), this);

    alert_ = new QLabel("ALERT!", this,
                        Qt::FramelessWindowHint|Qt::WindowStaysOnTopHint);
    alert_->setScaledContents(true);
    alert_->hide();
    alertAnime_ = new QPropertyAnimation(alert_, "geometry", this);
    alertAnime_->setDuration(2000);
    alertAnime_->setEasingCurve(QEasingCurve::InOutExpo);

    connect(level, SIGNAL(currentIndexChanged(int)),
            model, SLOT(setLogLevel(int)));
    connect(clear, SIGNAL(clicked()), model, SLOT(clear()));

    connect(parentDock_, SIGNAL(visibilityChanged(bool)),
            SLOT(when_visibilityChanged(bool)));
    connect(model, SIGNAL(rowsInserted(const QModelIndex&, int, int)),
            SLOT(when_rowsInserted(const QModelIndex&, int, int)));

    connect(logs->horizontalHeader(), SIGNAL(sectionResized(int, int, int)),
            logs, SLOT(resizeRowsToContents()));

#if defined(QT_NO_DEBUG) || QT_VERSION < 0x050700
    logsModelTest_ = nullptr;
#else
    logsModelTest_ = new ModelTest(model);
#endif
}

LogsWindow::~LogsWindow()
{
    delete warnAnime_;
    delete errorAnime_;
    delete logsModelTest_;
}

void LogsWindow::clearCurrentSelection()
{
    logs->selectionModel()->clearCurrentIndex();
    logs->clearSelection();
}

void LogsWindow::when_visibilityChanged(bool visible)
{
    if (visible) {
        logs->resizeRowsToContents();
        setState(kInfo);
    }

    isVisible_ = visible;
    qDebug("isVisible = %u", isVisible_);
}

void LogsWindow::when_rowsInserted(const QModelIndex &parent,
                                   int first, int last)
{
    if (isVisible_)
        logs->resizeRowsToContents();

    State incrementalState = kInfo;
    for (int i = first; i <= last; i++) {
        // FIXME: use a user-role instead, so we don't need to know column and
        // have to compare strings?
        QString level = logs->model()->data(logs->model()->index(i, 1, parent))
                                        .toString();
        if (level == "Error") {
            incrementalState = kError;
            break; // Highest level - no need to look further
        }
        else if (level == "Warning") {
            incrementalState = kWarning;
        }
    }
    alert(incrementalState);
    if (incrementalState > state())
        setState(incrementalState);
}

void LogsWindow::on_autoScroll_toggled(bool checked)
{
    if (checked) {
        connect(logs->model(),
                SIGNAL(rowsInserted(const QModelIndex&, int, int)),
                logs, SLOT(scrollToBottom()));
    }
    else {
        disconnect(logs->model(),
                SIGNAL(rowsInserted(const QModelIndex&, int, int)),
                logs, SLOT(scrollToBottom()));
    }
}

LogsWindow::State LogsWindow::state()
{
   return state_;
}

void LogsWindow::setState(State state)
{
    if (isVisible_)
        return;
    state_ = state;
    notify();
}

QLabel* LogsWindow::tabIcon()
{
    QList<QTabBar*> tabBars = mainWindow->findChildren<QTabBar*>();
    foreach(QTabBar* tabBar, tabBars) {
        for (int i = 0; i < tabBar->count(); i++) {
            if (tabBar->tabText(i).startsWith(windowTitle_)) {
                QLabel *icon = qobject_cast<QLabel*>(
                                    tabBar->tabButton(i, QTabBar::LeftSide));
                if (!icon) { // Lazy create
                    icon = new QLabel();
                    tabBar->setTabButton(i, QTabBar::LeftSide, icon);
                }
                return icon;
            }
        }
    }

    return nullptr;
}

//! Popup and animate a big icon
void LogsWindow::alert(State state)
{
    if (state == kInfo)
        return;

    // start - center of main window
    QRect start;
    QWidget *view = mainWindow;
    if (!view)
        return;
    alert_->setParent(view);
    alert_->raise();
    start.setSize(QSize(256, 256).scaled(view->size()/2, Qt::KeepAspectRatio));
    start.moveCenter(QPoint(view->size().width()/2,
                            view->size().height()/2));
    // end - center of logs window if visible, tab icon otherwise
    QPoint c;
    QLabel *icon = tabIcon();
    view = isVisible_ ? dynamic_cast<QWidget*>(this) : mainWindow;
    if (icon && !isVisible_) {
        c = icon->geometry().center();  // in icon's parent (tabBar) coords
        c = icon->mapFromParent(c);     // in icon's own coords
        c = icon->mapTo(view, c);       // in mainWindow's coords
    } else {
        c = view->geometry().center();
        c = view->mapTo(mainWindow, c); // in mainWindow's coords
    }

    QRect end;
    end.moveCenter(c);

    switch (state) {
    case kError:
        alert_->setPixmap(QPixmap(":/icons/error.svg"));
        break;
    case kWarning:
        alert_->setPixmap(QPixmap(":/icons/warn.svg"));
        break;
    default:
        Q_UNREACHABLE();
        break;
    }

    alertAnime_->setStartValue(start);
    alertAnime_->setEndValue(end);
    alert_->show(); // ensure it's visible before starting animation
    alertAnime_->start();
}

//! Show tab icon
void LogsWindow::notify()
{
    QString annotation;
    QMovie *anime = nullptr;

    // Stop all animations before we start a new one
    warnAnime_->stop();
    errorAnime_->stop();

    switch (state()) {
    case kError:
        anime = errorAnime_;
        annotation = " - Error(s)";
        break;
    case kWarning:
        anime = warnAnime_;
        annotation = " - Warning(s)";
        break;
    case kInfo:
    default:
        break;
    }

    QLabel *icon = tabIcon(); // NOTE: we may not have a icon if not tabified
    if (icon) {
        if (anime) {
            icon->setMovie(anime);
            anime->start();
        }
        else
            icon->clear();
        icon->adjustSize();
    }
    parentDock_->setWindowTitle(windowTitle_ + annotation);
}