pcm_task_manager.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2021 Andrew Lutsenko, anlutsenko at gmail dot com
 * Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * This program 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/>.
 */
 
#ifndef PCM_TASK_MANAGER_H_
#define PCM_TASK_MANAGER_H_
 
#include "dialogs/dialog_pcm_progress.h"
#include "pcm.h"
#include "pcm_data.h"
#include <core/sync_queue.h>
#include <atomic>
#include <condition_variable>
#include <functional>
#include <memory>
#include <mutex>
#include <nlohmann/json-schema.hpp>
#include <widgets/wx_progress_reporters.h>
#include <wx/regex.h>
#include <wx/string.h>
 
 
class PCM_TASK_MANAGER
{
public:
    enum class STATUS
    {
        FAILED             = -1,
        INITIALIZED       = 0,
        SUCCESS           = 1
    };
 
    typedef std::function<STATUS()> PCM_TASK;
 
    PCM_TASK_MANAGER( std::shared_ptr<PLUGIN_CONTENT_MANAGER> pcm ) : m_pcm( pcm ){};
 
    PCM_TASK_MANAGER::STATUS DownloadAndInstall( const PCM_PACKAGE& aPackage, const wxString& aVersion,
                             const wxString& aRepositoryId, const bool isUpdate );
 
    PCM_TASK_MANAGER::STATUS Uninstall( const PCM_PACKAGE& aPackage );
 
    void RunQueue( wxWindow* aParent );
 
    PCM_TASK_MANAGER::STATUS InstallFromFile( wxWindow* aParent, const wxString& aFilePath );
 
    std::unordered_set<PCM_PACKAGE_TYPE>& GetChangedPackageTypes()
    {
        return m_changed_package_types;
    };
 
private:
    int downloadFile( const wxString& aFilePath, const wxString& aUrl );
 
    PCM_TASK_MANAGER::STATUS installDownloadedPackage( const PCM_PACKAGE& aPackage,
                                                       const wxString&    aVersion,
                                                       const wxString&    aRepositoryId,
                                                       const wxFileName&  aFilePath,
                                                       const bool         isUpdate );
 
    bool extract( const wxString& aFilePath, const wxString& aPackageId, bool isMultiThreaded );
 
    void deletePackageDirectories( const wxString&                   aPackageId,
                                   const std::forward_list<wxRegEx>& aKeep = {} );
 
    std::unique_ptr<DIALOG_PCM_PROGRESS>    m_reporter;
    SYNC_QUEUE<PCM_TASK>                    m_download_queue;
    SYNC_QUEUE<PCM_TASK>                    m_install_queue;
    std::shared_ptr<PLUGIN_CONTENT_MANAGER> m_pcm;
    std::mutex                              m_changed_package_types_guard;
    std::unordered_set<PCM_PACKAGE_TYPE>    m_changed_package_types;
};
 
 
#endif // PCM_TASK_MANAGER_H_