panel_embedded_files.cpp

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The 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 <https://www.gnu.org/licenses/>.
 */
 
#include <eda_item.h>
#include <confirm.h>
#include <bitmaps.h>
#include <dialogs/panel_embedded_files.h>
#include <embedded_files.h>
#include <font/outline_font.h>
#include <kidialog.h>
#include <widgets/std_bitmap_button.h>
#include <widgets/wx_grid.h>
 
#include <wx/clipbrd.h>
#include <wx/dirdlg.h>
#include <wx/filedlg.h>
#include <wx/filename.h>
#include <wx/log.h>
#include <wx/menu.h>
#include <wx/wfstream.h>
#include <wx/wupdlock.h>
#include <kiplatform/ui.h>
 
/* ---------- GRID_TRICKS for embedded files grid ---------- */
 
EMBEDDED_FILES_GRID_TRICKS::EMBEDDED_FILES_GRID_TRICKS( WX_GRID* aGrid ) :
        GRID_TRICKS( aGrid ),
        m_curRow( -1 )
{
}
 
 
void EMBEDDED_FILES_GRID_TRICKS::showPopupMenu( wxMenu& menu, wxGridEvent& aEvent )
{
    if( const int row = aEvent.GetRow(); row >= 0 && row < m_grid->GetNumberRows() )
    {
        m_curRow = row;
        menu.Append( EMBEDDED_FILES_GRID_TRICKS_COPY_FILENAME, _( "Copy Embedded Reference" ),
                     _( "Copy the reference for this embedded file" ) );
        menu.AppendSeparator();
        GRID_TRICKS::showPopupMenu( menu, aEvent );
    }
    else
    {
        m_curRow = -1;
    }
}
 
 
void EMBEDDED_FILES_GRID_TRICKS::doPopupSelection( wxCommandEvent& event )
{
    if( event.GetId() == EMBEDDED_FILES_GRID_TRICKS_COPY_FILENAME )
    {
        if( m_curRow >= 0 )
        {
            const wxString cellValue = m_grid->GetCellValue( m_curRow, 1 );
 
            if( wxTheClipboard->Open() )
            {
                wxTheClipboard->SetData( new wxTextDataObject( cellValue ) );
                wxTheClipboard->Close();
            }
        }
    }
    else
    {
        GRID_TRICKS::doPopupSelection( event );
    }
}
 
 
/* ---------- End of GRID_TRICKS for embedded files grid ---------- */
 
 
PANEL_EMBEDDED_FILES::PANEL_EMBEDDED_FILES( wxWindow* aParent, EMBEDDED_FILES* aFiles, int aFlags,
                                            std::vector<const EMBEDDED_FILES*> aInheritedFiles ) :
        PANEL_EMBEDDED_FILES_BASE( aParent ),
        m_files( aFiles ),
        m_localFiles( new EMBEDDED_FILES() ),
        m_inheritedFiles( std::move( aInheritedFiles ) )
{
    m_files_grid->SetUseNativeColLabels();
 
    // Deep-copy entries into m_localFiles so that user edits in the dialog (add/remove) operate
    // on an isolated working copy.  m_localFiles is committed back to m_files on OK.
    for( auto& [name, file] : m_files->EmbeddedFileMap() )
        m_localFiles->AddFile( new EMBEDDED_FILES::EMBEDDED_FILE( *file ) );
 
    for( const EMBEDDED_FILES* inheritedFiles : m_inheritedFiles )
    {
        for( auto& [name, file] : inheritedFiles->EmbeddedFileMap() )
        {
            if( m_localFiles->HasFile( name ) )
                continue;
 
            m_localFiles->AddFile( new EMBEDDED_FILES::EMBEDDED_FILE( *file ) );
            m_inheritedFileNames.insert( name );
        }
    }
 
    if( aFlags & NO_MARGINS )
    {
        m_filesGridSizer->Detach( m_files_grid );
        m_filesGridSizer->Add( m_files_grid, 5, wxEXPAND, 5 );
 
        m_buttonsSizer->Detach( m_browse_button );
        m_buttonsSizer->Prepend( m_browse_button, 0, wxALIGN_CENTER_VERTICAL|wxRIGHT, 5 );
 
        m_buttonsSizer->Detach( m_export );
        m_buttonsSizer->Add( m_export, 0, wxALIGN_CENTER_VERTICAL|wxRIGHT, 5 );
    }
 
    // Set up the standard buttons
    m_delete_button->SetBitmap( KiBitmapBundle( BITMAPS::small_trash ) );
    m_browse_button->SetBitmap( KiBitmapBundle( BITMAPS::small_folder ) );
    m_files_grid->SetMargins( 0 - wxSYS_VSCROLL_X, 0 );
    m_files_grid->EnableAlternateRowColors();
 
    m_files_grid->PushEventHandler( new EMBEDDED_FILES_GRID_TRICKS( m_files_grid ) );
    m_files_grid->SetupColumnAutosizer( 1 );
 
    m_localFiles->SetFileAddedCallback(
            [this](EMBEDDED_FILES::EMBEDDED_FILE* file)
            {
                for( int ii = 0; ii < m_files_grid->GetNumberRows(); ii++ )
                {
                    if( m_files_grid->GetCellValue( ii, 1 ) == file->GetLink() )
                    {
                        m_files_grid->DeleteRows( ii );
                        break;
                    }
                }
 
                m_files_grid->AppendRows( 1 );
                int ii = m_files_grid->GetNumberRows() - 1;
                m_files_grid->SetCellValue( ii, 0, file->name );
                m_files_grid->SetCellValue( ii, 1, file->GetLink() );
 
            } );
}
 
 
PANEL_EMBEDDED_FILES::~PANEL_EMBEDDED_FILES()
{
    // Remove the GRID_TRICKS handler
    m_files_grid->PopEventHandler( true );
    delete m_localFiles;
}
 
 
bool PANEL_EMBEDDED_FILES::TransferDataToWindow()
{
    m_files_grid->ClearGrid();
    m_files_grid->ClearRows();
 
    int ii = 0;
 
    for( auto& [name, file] : m_localFiles->EmbeddedFileMap() )
    {
        while( m_files_grid->GetNumberRows() < ii + 1 )
            m_files_grid->AppendRows( 1 );
 
        m_files_grid->SetCellValue( ii, 0, name );
        m_files_grid->SetCellValue( ii, 1, file->GetLink() );
 
        ii++;
    }
 
    m_cbEmbedFonts->SetValue( m_files->GetAreFontsEmbedded() );
    return true;
}
 
 
bool PANEL_EMBEDDED_FILES::TransferDataFromWindow()
{
    std::optional<bool> deleteReferences;
 
    auto confirmDelete =
            [&]() -> bool
            {
                if( EDA_ITEM* parent = dynamic_cast<EDA_ITEM*>( m_files ) )
                {
                    if( parent->Type() == PCB_T )
                    {
                        return IsOK( m_parent, _( "Deleted embedded files are also referenced in some footprints.\n"
                                                  "Delete from footprints as well?" ) );
                    }
                    else if( parent->Type() == SCHEMATIC_T )
                    {
                        return IsOK( m_parent, _( "Deleted embedded files are also referenced in some symbols.\n"
                                                  "Delete from symbols as well?" ) );
                    }
                }
 
                wxFAIL_MSG( wxT( "Unexpected embedded files owner" ) );
                return false;
            };
 
    for( const auto& [name, file] : m_files->EmbeddedFileMap() )
    {
        if( !m_localFiles->HasFile( name ) )
        {
            m_files->RunOnNestedEmbeddedFiles(
                    [&]( EMBEDDED_FILES* nested_files )
                    {
                        if( nested_files->HasFile( name ) )
                        {
                            if( !deleteReferences.has_value() )
                                deleteReferences = confirmDelete();
 
                            if( deleteReferences.value() )
                                nested_files->RemoveFile( name, true );
                        }
                    } );
        }
 
        if( deleteReferences.has_value() && deleteReferences.value() == false )
            break;
    }
 
    // Share the payloads instead of moving them out of m_localFiles.  PAGED_DIALOG commits on
    // both page change and OK, so a destructive commit would wipe every embedded file on the
    // second pass.
    m_files->AssignSharedFrom( *m_localFiles, m_inheritedFileNames );
 
    m_files->SetAreFontsEmbedded( m_cbEmbedFonts->IsChecked() );
 
    return true;
}
 
 
void PANEL_EMBEDDED_FILES::onFontEmbedClick( wxCommandEvent& event )
{
    wxWindowUpdateLocker updateLock( this );
 
    int row_pos = m_files_grid->GetGridCursorRow();
    int col_pos = m_files_grid->GetGridCursorCol();
    wxString row_name;
 
    if( row_pos >= 0 )
        row_name = m_files_grid->GetCellValue( row_pos, 0 );
 
    for( int ii = 0; ii < m_files_grid->GetNumberRows(); ii++ )
    {
        wxString name = m_files_grid->GetCellValue( ii, 0 );
 
        EMBEDDED_FILES::EMBEDDED_FILE* file = m_localFiles->GetEmbeddedFile( name );
 
        if( file && file->type == EMBEDDED_FILES::EMBEDDED_FILE::FILE_TYPE::FONT )
        {
            m_files_grid->DeleteRows( ii );
            ii--;
            m_localFiles->RemoveFile( name );
        }
    }
 
    if( m_cbEmbedFonts->IsChecked() )
    {
        std::set<KIFONT::OUTLINE_FONT*> fonts = m_files->GetFonts();
 
        for( KIFONT::OUTLINE_FONT* font : fonts )
        {
            EMBEDDED_FILES::EMBEDDED_FILE* result = m_localFiles->AddFile( font->GetFileName(), true );
 
            if( !result )
            {
                wxLogTrace( wxT( "KICAD_EMBED" ), wxString::Format( "Could not embed font %s",
                                                                    font->GetFileName() ) );
                continue;
            }
        }
    }
 
    if( row_pos >= 0 )
    {
        col_pos = std::max( std::min( col_pos, m_files_grid->GetNumberCols() - 1 ), 0 );
        row_pos = std::max( std::min( row_pos, m_files_grid->GetNumberRows() - 1 ), 0 );
        m_files_grid->SetGridCursor( row_pos, col_pos );
 
        for( int ii = 0; ii < m_files_grid->GetNumberRows(); ++ii )
        {
            if( m_files_grid->GetCellValue( ii, 0 ) == row_name )
            {
                m_files_grid->SetGridCursor( ii, col_pos );
                break;
            }
        }
    }
}
 
 
EMBEDDED_FILES::EMBEDDED_FILE* PANEL_EMBEDDED_FILES::AddEmbeddedFile( const wxString& aFile )
{
    wxFileName fileName( aFile );
    wxString   name = fileName.GetFullName();
 
    if( m_localFiles->HasFile( name ) )
    {
        EMBEDDED_FILES::EMBEDDED_FILE* existingFile = m_localFiles->GetEmbeddedFile( name );
        std::string newFileHash;
 
        if( EMBEDDED_FILES::ComputeFileHash( fileName, newFileHash ) != EMBEDDED_FILES::RETURN_CODE::OK )
        {
            wxString msg = wxString::Format( _( "Failed to read file '%s'." ), name );
            KIDIALOG errorDlg( m_parent, msg, _( "Error" ), wxOK | wxICON_ERROR );
            errorDlg.ShowModal();
            return nullptr;
        }
 
        if( existingFile && existingFile->data_hash == newFileHash )
        {
            return existingFile;
        }
 
        wxString msg = wxString::Format(
                _( "A file named '%s' is already embedded, but the file on disk has different "
                   "content.\n\nDo you want to replace the embedded file with the new version?" ),
                name );
 
        KIDIALOG dlg( m_parent, msg, _( "Embedded File Conflict" ),
                      wxYES_NO | wxCANCEL | wxICON_WARNING );
        dlg.SetYesNoLabels( _( "Replace" ), _( "Reuse Existing" ) );
 
        int result = dlg.ShowModal();
 
        if( result == wxID_CANCEL )
            return nullptr;
 
        if( result == wxID_NO )
        {
            return existingFile;
        }
 
        for( int ii = 0; ii < m_files_grid->GetNumberRows(); ii++ )
        {
            if( m_files_grid->GetCellValue( ii, 0 ) == name )
            {
                m_files_grid->DeleteRows( ii );
                break;
            }
        }
    }
 
    EMBEDDED_FILES::EMBEDDED_FILE* result = m_localFiles->AddFile( fileName, true );
 
    if( !result )
    {
        wxString msg = wxString::Format( _( "Failed to add file '%s'." ), name );
 
        KIDIALOG errorDlg( m_parent, msg, _( "Error" ), wxOK | wxICON_ERROR );
        errorDlg.ShowModal();
        return nullptr;
    }
 
    return result;
}
 
 
void PANEL_EMBEDDED_FILES::onAddEmbeddedFiles( wxCommandEvent& event )
{
    // TODO: Update strings to reflect that multiple files can be selected.
    wxFileDialog fileDialog( this, _( "Select a file to embed" ), wxEmptyString, wxEmptyString,
                             _( "All Files" ) + wxT( " (*.*)|*.*" ),
                             wxFD_OPEN | wxFD_FILE_MUST_EXIST | wxFD_MULTIPLE );
 
    KIPLATFORM::UI::AllowNetworkFileSystems( &fileDialog );
 
    if( fileDialog.ShowModal() == wxID_OK )
    {
        wxArrayString paths;
        fileDialog.GetPaths( paths );
 
        for( const wxString& path : paths )
            AddEmbeddedFile( path );
    }
}
 
 
bool PANEL_EMBEDDED_FILES::RemoveEmbeddedFile( const wxString& aFileName )
{
    wxString name = aFileName;
 
    if( name.StartsWith( FILEEXT::KiCadUriPrefix ) )
        name = name.Mid( FILEEXT::KiCadUriPrefix.size() + 3 );
 
    if( m_inheritedFileNames.count( name ) )
    {
        wxString msg = _( "Embedded files inherited from a parent symbol cannot be removed." );
 
        DisplayErrorMessage( this, msg );
        return false;
    }
 
    int row = std::max( 0, m_files_grid->GetGridCursorRow() );
 
    for( int ii = 0; ii < m_files_grid->GetNumberRows(); ii++ )
    {
        if( m_files_grid->GetCellValue( ii, 0 ) == name )
        {
            m_files_grid->DeleteRows( ii );
            m_localFiles->RemoveFile( name );
 
            if( row < m_files_grid->GetNumberRows() )
                m_files_grid->SetGridCursor( row, 0 );
            else if( m_files_grid->GetNumberRows() > 0 )
                m_files_grid->SetGridCursor( m_files_grid->GetNumberRows() - 1, 0 );
 
            return true;
        }
    }
 
    return false;
}
 
 
void PANEL_EMBEDDED_FILES::onDeleteEmbeddedFile( wxCommandEvent& event )
{
    m_files_grid->OnDeleteRows(
            [&]( int row )
            {
                wxString name = m_files_grid->GetCellValue( row, 0 );
 
                RemoveEmbeddedFile( name );
            } );
}
 
 
void PANEL_EMBEDDED_FILES::onExportFiles( wxCommandEvent& event )
{
    wxDirDialog dirDialog( this, _( "Select a directory to export files" ) );
 
    if( dirDialog.ShowModal() != wxID_OK )
        return;
 
    wxString path = dirDialog.GetPath();
 
    for( auto& [name, file] : m_localFiles->EmbeddedFileMap() )
    {
        wxFileName fileName( path, name );
 
        if( fileName.FileExists() )
        {
            wxString msg = wxString::Format( _( "File '%s' already exists." ), fileName.GetFullName() );
 
            KIDIALOG errorDlg( m_parent, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
            errorDlg.SetOKCancelLabels( _( "Overwrite" ), _( "Skip" ) );
            errorDlg.DoNotShowCheckbox( __FILE__, __LINE__ );
 
            if( errorDlg.ShowModal() != wxID_OK )
                continue;
        }
 
        bool skip_file = false;
 
        while( 1 )
        {
            if( !fileName.IsDirWritable() )
            {
#ifndef __WXMAC__
                wxString msg = wxString::Format( _( "Directory '%s' is not writable." ), fileName.GetFullName() );
#else
                wxString msg = wxString::Format( _( "Folder '%s' is not writable." ), fileName.GetPath() );
#endif
                // Don't set a 'do not show again' checkbox for this dialog
                KIDIALOG errorDlg( m_parent, msg, _( "Error" ), wxYES_NO | wxCANCEL | wxICON_ERROR );
                errorDlg.SetYesNoCancelLabels( _( "Retry" ), _( "Skip" ), _( "Cancel" ) );
 
                int result = errorDlg.ShowModal();
 
                if( result == wxID_CANCEL )
                {
                    return;
                }
                else if( result == wxID_NO )
                {
                    skip_file = true;
                    break;
                }
            }
            else
            {
                break;
            }
        }
 
        if( skip_file )
            continue;
 
 
        wxFFileOutputStream out( fileName.GetFullPath() );
 
        if( !out.IsOk() )
        {
            wxString msg = wxString::Format( _( "Failed to open file '%s'." ), fileName.GetFullName() );
 
            KIDIALOG errorDlg( m_parent, msg, _( "Error" ), wxOK | wxICON_ERROR );
            errorDlg.ShowModal();
            continue;
        }
 
        out.Write( file->decompressedData.data(), file->decompressedData.size() );
 
        if( !out.IsOk() || ( out.LastWrite() != file->decompressedData.size() ) )
        {
            wxString msg = wxString::Format( _( "Failed to write file '%s'." ), fileName.GetFullName() );
 
            KIDIALOG errorDlg( m_parent, msg, _( "Error" ), wxOK | wxICON_ERROR );
 
            errorDlg.ShowModal();
        }
    }
}