libfm-qt-packaging/src/fileoperation.cpp

/*
 * Copyright (C) 2012 - 2015  Hong Jen Yee (PCMan) <pcman.tw@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */


#include "fileoperation.h"
#include "fileoperationdialog.h"
#include <QTimer>
#include <QElapsedTimer>
#include <QMessageBox>
#include <QDebug>
#include "path.h"

#include "core/compat_p.h"

namespace Fm {

#define SHOW_DLG_DELAY  1000

FileOperation::FileOperation(Type type, Fm::FilePathList srcFiles, QObject* parent):
    QObject(parent),
    job_{fm_file_ops_job_new((FmFileOpType)type, Fm::_convertPathList(srcFiles))},
    dlg{nullptr},
    srcPaths{std::move(srcFiles)},
    uiTimer(nullptr),
    elapsedTimer_(nullptr),
    lastElapsed_(0),
    updateRemainingTime_(true),
    autoDestroy_(true) {

    g_signal_connect(job_, "ask", G_CALLBACK(onFileOpsJobAsk), this);
    g_signal_connect(job_, "ask-rename", G_CALLBACK(onFileOpsJobAskRename), this);
    g_signal_connect(job_, "error", G_CALLBACK(onFileOpsJobError), this);
    g_signal_connect(job_, "prepared", G_CALLBACK(onFileOpsJobPrepared), this);
    g_signal_connect(job_, "cur-file", G_CALLBACK(onFileOpsJobCurFile), this);
    g_signal_connect(job_, "percent", G_CALLBACK(onFileOpsJobPercent), this);
    g_signal_connect(job_, "finished", G_CALLBACK(onFileOpsJobFinished), this);
    g_signal_connect(job_, "cancelled", G_CALLBACK(onFileOpsJobCancelled), this);
}

void FileOperation::disconnectJob() {
    g_signal_handlers_disconnect_by_func(job_, (gpointer)G_CALLBACK(onFileOpsJobAsk), this);
    g_signal_handlers_disconnect_by_func(job_, (gpointer)G_CALLBACK(onFileOpsJobAskRename), this);
    g_signal_handlers_disconnect_by_func(job_, (gpointer)G_CALLBACK(onFileOpsJobError), this);
    g_signal_handlers_disconnect_by_func(job_, (gpointer)G_CALLBACK(onFileOpsJobPrepared), this);
    g_signal_handlers_disconnect_by_func(job_, (gpointer)G_CALLBACK(onFileOpsJobCurFile), this);
    g_signal_handlers_disconnect_by_func(job_, (gpointer)G_CALLBACK(onFileOpsJobPercent), this);
    g_signal_handlers_disconnect_by_func(job_, (gpointer)G_CALLBACK(onFileOpsJobFinished), this);
    g_signal_handlers_disconnect_by_func(job_, (gpointer)G_CALLBACK(onFileOpsJobCancelled), this);
}

FileOperation::~FileOperation() {
    if(uiTimer) {
        uiTimer->stop();
        delete uiTimer;
        uiTimer = nullptr;
    }
    if(elapsedTimer_) {
        delete elapsedTimer_;
        elapsedTimer_ = nullptr;
    }

    if(job_) {
        disconnectJob();
        g_object_unref(job_);
    }
}

void FileOperation::setDestination(Fm::FilePath dest) {
    destPath = std::move(dest);
    auto tmp = Fm::Path::newForGfile(dest.gfile().get());
    fm_file_ops_job_set_dest(job_, tmp.dataPtr());
}

bool FileOperation::run() {
    delete uiTimer;
    // run the job
    uiTimer = new QTimer();
    uiTimer->start(SHOW_DLG_DELAY);
    connect(uiTimer, &QTimer::timeout, this, &FileOperation::onUiTimeout);

    return fm_job_run_async(FM_JOB(job_));
}

void FileOperation::onUiTimeout() {
    if(dlg) {
        dlg->setCurFile(curFile);
        // estimate remaining time based on past history
        // FIXME: avoid directly access data member of FmFileOpsJob
        if(Q_LIKELY(job_->percent > 0 && updateRemainingTime_)) {
            gint64 remaining = elapsedTime() * ((double(100 - job_->percent) / job_->percent) / 1000);
            dlg->setRemainingTime(remaining);
        }
        // this timeout slot is called every 0.5 second.
        // by adding this flag, we can update remaining time every 1 second.
        updateRemainingTime_ = !updateRemainingTime_;
    }
    else {
        showDialog();
    }
}

void FileOperation::showDialog() {
    if(!dlg) {
        dlg = new FileOperationDialog(this);
        dlg->setSourceFiles(srcPaths);

        if(destPath) {
            dlg->setDestPath(destPath);
        }

        if(curFile.isEmpty()) {
            dlg->setPrepared();
            dlg->setCurFile(curFile);
        }
        uiTimer->setInterval(500); // change the interval of the timer
        // now the timer is used to update current file display
        dlg->show();
    }
}

gint FileOperation::onFileOpsJobAsk(FmFileOpsJob* /*job*/, const char* question, char* const* options, FileOperation* pThis) {
    pThis->pauseElapsedTimer();
    pThis->showDialog();
    int ret = pThis->dlg->ask(QString::fromUtf8(question), options);
    pThis->resumeElapsedTimer();
    return ret;
}

gint FileOperation::onFileOpsJobAskRename(FmFileOpsJob* /*job*/, FmFileInfo* src, FmFileInfo* dest, char** new_name, FileOperation* pThis) {
    pThis->pauseElapsedTimer();
    pThis->showDialog();
    QString newName;
    int ret = pThis->dlg->askRename(src, dest, newName);
    if(!newName.isEmpty()) {
        *new_name = g_strdup(newName.toUtf8().constData());
    }
    pThis->resumeElapsedTimer();
    return ret;
}

void FileOperation::onFileOpsJobCancelled(FmFileOpsJob* /*job*/, FileOperation* /*pThis*/) {
    qDebug("file operation is cancelled!");
}

void FileOperation::onFileOpsJobCurFile(FmFileOpsJob* /*job*/, const char* cur_file, FileOperation* pThis) {
    pThis->curFile = QString::fromUtf8(cur_file);

    // We update the current file name in a timeout slot because drawing a string
    // in the UI is expansive. Updating the label text too often cause
    // significant impact on performance.
    // if(pThis->dlg)
    //  pThis->dlg->setCurFile(pThis->curFile);
}

FmJobErrorAction FileOperation::onFileOpsJobError(FmFileOpsJob* /*job*/, GError* err, FmJobErrorSeverity severity, FileOperation* pThis) {
    pThis->pauseElapsedTimer();
    pThis->showDialog();
    FmJobErrorAction act = pThis->dlg->error(err, severity);
    pThis->resumeElapsedTimer();
    return act;
}

void FileOperation::onFileOpsJobFinished(FmFileOpsJob* /*job*/, FileOperation* pThis) {
    pThis->handleFinish();
}

void FileOperation::onFileOpsJobPercent(FmFileOpsJob* job, guint percent, FileOperation* pThis) {
    if(pThis->dlg) {
        pThis->dlg->setPercent(percent);
        pThis->dlg->setDataTransferred(job->finished, job->total);
    }
}

void FileOperation::onFileOpsJobPrepared(FmFileOpsJob* /*job*/, FileOperation* pThis) {
    if(!pThis->elapsedTimer_) {
        pThis->elapsedTimer_ = new QElapsedTimer();
        pThis->elapsedTimer_->start();
    }
    if(pThis->dlg) {
        pThis->dlg->setPrepared();
    }
}

void FileOperation::handleFinish() {
    disconnectJob();

    if(uiTimer) {
        uiTimer->stop();
        delete uiTimer;
        uiTimer = nullptr;
    }

    if(dlg) {
        dlg->done(QDialog::Accepted);
        delete dlg;
        dlg = nullptr;
    }
    Q_EMIT finished();

    /* sepcial handling for trash
     * FIXME: need to refactor this to use a more elegant way later. */
    if(job_->type == FM_FILE_OP_TRASH) { /* FIXME: direct access to job struct! */
        auto unable_to_trash = static_cast<FmPathList*>(g_object_get_data(G_OBJECT(job_), "trash-unsupported"));
        /* some files cannot be trashed because underlying filesystems don't support it. */
        if(unable_to_trash) { /* delete them instead */
            Fm::FilePathList filesToDel;
            for(GList* l = fm_path_list_peek_head_link(unable_to_trash); l; l = l->next) {
                filesToDel.push_back(Fm::FilePath{fm_path_to_gfile(FM_PATH(l->data)), false});
            }
            /* FIXME: parent window might be already destroyed! */
            QWidget* parent = nullptr; // FIXME: currently, parent window is not set
            if(QMessageBox::question(parent, tr("Error"),
                                     tr("Some files cannot be moved to trash can because "
                                        "the underlying file systems don't support this operation.\n"
                                        "Do you want to delete them instead?")) == QMessageBox::Yes) {
                deleteFiles(std::move(filesToDel), false);
            }
        }
    }
    g_object_unref(job_);
    job_ = nullptr;

    if(autoDestroy_) {
        delete this;
    }
}

// static
FileOperation* FileOperation::copyFiles(Fm::FilePathList srcFiles, Fm::FilePath dest, QWidget* parent) {
    FileOperation* op = new FileOperation(FileOperation::Copy, std::move(srcFiles), parent);
    op->setDestination(dest);
    op->run();
    return op;
}

// static
FileOperation* FileOperation::moveFiles(Fm::FilePathList srcFiles, Fm::FilePath dest, QWidget* parent) {
    FileOperation* op = new FileOperation(FileOperation::Move, std::move(srcFiles), parent);
    op->setDestination(dest);
    op->run();
    return op;
}

//static
FileOperation* FileOperation::symlinkFiles(Fm::FilePathList srcFiles, Fm::FilePath dest, QWidget* parent) {
    FileOperation* op = new FileOperation(FileOperation::Link, std::move(srcFiles), parent);
    op->setDestination(dest);
    op->run();
    return op;
}

//static
FileOperation* FileOperation::deleteFiles(Fm::FilePathList srcFiles, bool prompt, QWidget* parent) {
    if(prompt) {
        int result = QMessageBox::warning(parent, tr("Confirm"),
                                          tr("Do you want to delete the selected files?"),
                                          QMessageBox::Yes | QMessageBox::No,
                                          QMessageBox::No);
        if(result != QMessageBox::Yes) {
            return nullptr;
        }
    }

    FileOperation* op = new FileOperation(FileOperation::Delete, std::move(srcFiles));
    op->run();
    return op;
}

//static
FileOperation* FileOperation::trashFiles(Fm::FilePathList srcFiles, bool prompt, QWidget* parent) {
    if(prompt) {
        int result = QMessageBox::warning(parent, tr("Confirm"),
                                          tr("Do you want to move the selected files to trash can?"),
                                          QMessageBox::Yes | QMessageBox::No,
                                          QMessageBox::No);
        if(result != QMessageBox::Yes) {
            return nullptr;
        }
    }

    FileOperation* op = new FileOperation(FileOperation::Trash, std::move(srcFiles));
    op->run();
    return op;
}

//static
FileOperation* FileOperation::unTrashFiles(Fm::FilePathList srcFiles, QWidget* parent) {
    FileOperation* op = new FileOperation(FileOperation::UnTrash, std::move(srcFiles), parent);
    op->run();
    return op;
}

// static
FileOperation* FileOperation::changeAttrFiles(Fm::FilePathList srcFiles, QWidget* parent) {
    //TODO
    FileOperation* op = new FileOperation(FileOperation::ChangeAttr, std::move(srcFiles), parent);
    op->run();
    return op;
}


} // namespace Fm