kicad/pcbnew/dialogs/wizard_add_fplib.cpp

865 lines
24 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
2015-03-30 16:42:39 +00:00
* Copyright (C) 2015 CERN
* @author Maciej Suminski <maciej.suminski@cern.ch>
* Copyright (C) 2014-2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 1992-2015 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 2
* 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
2015-03-30 16:42:39 +00:00
/**
* @brief Wizard for selecting footprint libraries consisting of 4 steps:
* - select source (Github/local files)
* - pick libraries
* - present a review of libraries (including validation)
* - select scope (global/project)
*/
2016-08-15 15:16:45 +00:00
#include <memory>
#include <wx/wx.h>
2015-03-30 16:42:39 +00:00
#include <wx/uri.h>
#include <wx/dir.h>
#include <wx/progdlg.h>
#include <pgm_base.h>
2015-03-30 16:42:39 +00:00
#include <project.h>
#include <wizard_add_fplib.h>
2015-03-30 16:42:39 +00:00
#include <fp_lib_table.h>
#include <confirm.h>
2015-03-30 16:42:39 +00:00
#include <class_module.h>
2015-03-30 16:42:39 +00:00
#ifdef BUILD_GITHUB_PLUGIN
#include <../github/github_getliblist.h>
#endif
2015-03-30 16:42:39 +00:00
// a key to store the default Kicad Github libs URL
#define KICAD_FPLIBS_URL_KEY wxT( "kicad_fplib_url" )
#define KICAD_FPLIBS_LAST_DOWNLOAD_DIR wxT( "kicad_fplib_last_download_dir" )
2015-03-30 16:42:39 +00:00
// Filters for the file picker
static const int FILTER_COUNT = 4;
static const struct
{
wxString m_Description; ///< Description shown in the file picker dialog
wxString m_Extension; ///< In case of folders it stands for extensions of files stored inside
bool m_IsFile; ///< Whether it is a folder or a file
2015-03-30 16:42:39 +00:00
IO_MGR::PCB_FILE_T m_Plugin;
} fileFilters[FILTER_COUNT] =
{
{ "KiCad (folder with .kicad_mod files)", "kicad_mod", false, IO_MGR::KICAD },
{ "Eagle 6.x (*.lbr)", "lbr", true, IO_MGR::EAGLE },
{ "KiCad legacy (*.mod)", "mod", true, IO_MGR::LEGACY },
{ "Geda (folder with *.fp files)", "fp", false, IO_MGR::GEDA_PCB },
2015-03-30 16:42:39 +00:00
};
2015-03-30 16:42:39 +00:00
// Returns the filter string for the file picker
static wxString getFilterString()
{
wxString filterInit = _( "All supported library formats|" );
wxString filter;
2015-03-30 16:42:39 +00:00
for( int i = 0; i < FILTER_COUNT; ++i )
{
// Init part
if( i != 0 )
filterInit += ";";
filterInit += "*." + fileFilters[i].m_Extension;
2015-03-30 16:42:39 +00:00
// Rest of the filter string
filter += "|" + fileFilters[i].m_Description +
"|" + ( fileFilters[i].m_IsFile ? "*." + fileFilters[i].m_Extension : "" );
}
2015-03-30 16:42:39 +00:00
return filterInit + filter;
}
2015-03-30 16:42:39 +00:00
// Tries to guess the plugin type basing on the path
static boost::optional<IO_MGR::PCB_FILE_T> getPluginType( const wxString& aPath )
{
if( ( aPath.StartsWith( "http://" ) || aPath.StartsWith( "https://" ) ) )
2015-03-30 16:42:39 +00:00
return boost::optional<IO_MGR::PCB_FILE_T>( IO_MGR::GITHUB );
wxFileName path( aPath );
2015-03-30 16:42:39 +00:00
for( int i = 0; i < FILTER_COUNT; ++i )
{
bool ok = false;
if( fileFilters[i].m_IsFile )
{
ok = path.IsFileReadable() && path.GetExt() == fileFilters[i].m_Extension;
}
else if( path.IsDirReadable() )
{
// Plugin expects a directory containing files with a specific extension
wxDir dir( aPath );
if( dir.IsOpened() )
{
wxString filename;
dir.GetFirst( &filename, "*." + fileFilters[i].m_Extension, wxDIR_FILES );
ok = !filename.IsEmpty();
}
}
if( ok )
2015-03-30 16:42:39 +00:00
return boost::optional<IO_MGR::PCB_FILE_T>( fileFilters[i].m_Plugin );
}
return boost::none;
}
2015-03-30 16:42:39 +00:00
// Checks if a filename fits specific filter
static bool passesFilter( const wxString& aFileName, int aFilterIndex )
{
2015-03-30 16:42:39 +00:00
wxASSERT( aFilterIndex <= FILTER_COUNT );
wxFileName file( aFileName );
boost::optional<IO_MGR::PCB_FILE_T> result = getPluginType( aFileName );
if( !result ) // does not match any supported plugin
return false;
if( aFilterIndex == 0 ) // any plugin will do
return true;
return ( fileFilters[aFilterIndex - 1].m_Plugin == *result );
2015-03-30 16:42:39 +00:00
}
2015-03-30 16:42:39 +00:00
WIZARD_FPLIB_TABLE::LIBRARY::LIBRARY( const wxString& aPath, const wxString& aDescription ) :
m_path( aPath ), m_description( aDescription ), m_status( NOT_CHECKED )
{
m_plugin = getPluginType( aPath );
}
2015-03-30 16:42:39 +00:00
bool WIZARD_FPLIB_TABLE::LIBRARY::Test()
{
2015-03-30 16:42:39 +00:00
if( !m_plugin )
{
2015-03-30 16:42:39 +00:00
m_status = LIBRARY::INVALID;
return false;
}
2015-03-30 16:42:39 +00:00
PLUGIN* p = IO_MGR::PluginFind( *m_plugin );
wxArrayString footprints;
2015-03-30 16:42:39 +00:00
if( !p )
{
m_status = LIBRARY::INVALID;
return false;
}
2015-03-30 16:42:39 +00:00
try
{
2015-03-30 16:42:39 +00:00
footprints = p->FootprintEnumerate( m_path );
}
2015-03-30 16:42:39 +00:00
catch( IO_ERROR& e )
{
2015-03-30 16:42:39 +00:00
m_status = LIBRARY::INVALID;
return false;
}
2015-03-30 16:42:39 +00:00
if( footprints.GetCount() == 0 )
{
m_status = LIBRARY::INVALID;
return false;
}
2015-03-30 16:42:39 +00:00
m_status = LIBRARY::OK;
return true;
}
2015-03-30 16:42:39 +00:00
wxString WIZARD_FPLIB_TABLE::LIBRARY::GetPluginName() const
{
2015-03-30 16:42:39 +00:00
if( !m_plugin )
return _( "UNKNOWN" );
2015-03-30 16:42:39 +00:00
switch( *m_plugin )
{
case IO_MGR::LEGACY:
return wxT( "Legacy" );
2015-03-30 16:42:39 +00:00
case IO_MGR::KICAD:
return wxT( "KiCad" );
2015-03-30 16:42:39 +00:00
case IO_MGR::EAGLE:
return wxT( "Eagle" );
2015-03-30 16:42:39 +00:00
case IO_MGR::GEDA_PCB:
return wxT( "Geda-PCB" );
2015-03-30 16:42:39 +00:00
case IO_MGR::GITHUB:
return wxT( "Github" );
2015-03-30 16:42:39 +00:00
default:
return _( "UNKNOWN" );
}
2015-03-30 16:42:39 +00:00
/*PLUGIN* p = IO_MGR::PluginFind( *m_plugin );
2015-03-30 16:42:39 +00:00
if( !p )
return _( "UNKNOWN" );
2015-03-30 16:42:39 +00:00
return p->PluginName();*/
}
2015-03-30 16:42:39 +00:00
wxString WIZARD_FPLIB_TABLE::LIBRARY::GetRelativePath( const wxString& aBase, const wxString& aSubstitution ) const
{
2015-03-30 16:42:39 +00:00
wxFileName libPath( m_path );
2015-03-30 16:42:39 +00:00
// Check if the library path belongs to the project folder
if( libPath.MakeRelativeTo( aBase ) && !libPath.GetFullPath().StartsWith( ".." ) )
{
2015-03-30 16:42:39 +00:00
return wxString( aSubstitution + "/" + libPath.GetFullPath() );
}
2015-03-30 16:42:39 +00:00
// Probably on another drive, so the relative path will not work
return wxEmptyString;
}
2015-03-30 16:42:39 +00:00
wxString WIZARD_FPLIB_TABLE::LIBRARY::GetAutoPath( LIB_SCOPE aScope ) const
{
const wxString& global_env = FP_LIB_TABLE::GlobalPathEnvVariableName();
const wxString& project_env = PROJECT_VAR_NAME;
const wxString& github_env( "KIGITHUB" );
2015-03-30 16:42:39 +00:00
wxString rel_path;
2015-03-30 16:42:39 +00:00
// KISYSMOD check
rel_path = replaceEnv( global_env );
2015-03-30 16:42:39 +00:00
if( !rel_path.IsEmpty() )
return rel_path;
2015-03-30 16:42:39 +00:00
// KIGITHUB check
rel_path = replaceEnv( github_env, false );
2015-03-30 16:42:39 +00:00
if( !rel_path.IsEmpty() )
return rel_path;
2015-03-30 16:42:39 +00:00
// KIPRJMOD check
if( aScope == PROJECT )
{
2015-03-30 16:42:39 +00:00
rel_path = replaceEnv( project_env );
2015-03-30 16:42:39 +00:00
if( !rel_path.IsEmpty() )
return rel_path;
}
2015-03-30 16:42:39 +00:00
// Return the full path
return m_path;
}
2015-03-30 16:42:39 +00:00
wxString WIZARD_FPLIB_TABLE::LIBRARY::GetDescription() const
{
2015-03-30 16:42:39 +00:00
if( !m_description.IsEmpty() )
return m_description;
2015-03-30 16:42:39 +00:00
wxFileName filename( m_path );
return filename.GetName();
}
2015-03-30 16:42:39 +00:00
wxString WIZARD_FPLIB_TABLE::LIBRARY::replaceEnv( const wxString& aEnvVar, bool aFilePath ) const
{
2015-03-30 16:42:39 +00:00
wxString env_path;
2015-03-30 16:42:39 +00:00
if( !wxGetEnv( aEnvVar, &env_path ) )
return wxEmptyString;
2015-03-30 16:42:39 +00:00
//return GetRelativePath( m_path, wxString( "$(" + aEnvVar + ")" ) );
2015-03-30 16:42:39 +00:00
wxString result( m_path );
2015-03-30 16:42:39 +00:00
if( result.Replace( env_path, wxString( "$(" + aEnvVar + ")" ) ) )
return result;
return wxEmptyString;
}
2015-03-30 16:42:39 +00:00
WIZARD_FPLIB_TABLE::WIZARD_FPLIB_TABLE( wxWindow* aParent ) :
WIZARD_FPLIB_TABLE_BASE( aParent ), m_welcomeDlg( m_pages[0] ),
m_fileSelectDlg( m_pages[1] ), m_githubListDlg( m_pages[2] ),
m_reviewDlg( m_pages[3] ), m_targetDlg( m_pages[4] ), m_selectedFilter( 0 )
{
m_filePicker->SetFilter( getFilterString() );
2015-03-30 16:42:39 +00:00
// Initialize default download dir
wxString default_path;
wxGetEnv( FP_LIB_TABLE::GlobalPathEnvVariableName(), &default_path );
setDownloadDir( default_path );
m_filePicker->SetPath( default_path );
2015-03-30 16:42:39 +00:00
// Restore the Github url
wxString githubUrl;
2015-03-30 16:42:39 +00:00
wxConfigBase* cfg = Pgm().CommonSettings();
cfg->Read( KICAD_FPLIBS_URL_KEY, &githubUrl );
cfg->Read( KICAD_FPLIBS_LAST_DOWNLOAD_DIR, &m_lastGithubDownloadDirectory );
if( !m_lastGithubDownloadDirectory.IsEmpty() )
{
setDownloadDir( m_lastGithubDownloadDirectory );
m_filePicker->SetPath( m_lastGithubDownloadDirectory );
} else {
m_lastGithubDownloadDirectory = default_path;
}
2015-03-30 16:42:39 +00:00
if( githubUrl.IsEmpty() )
githubUrl = wxT( "https://github.com/KiCad" );
2015-03-30 16:42:39 +00:00
SetGithubURL( githubUrl );
2015-03-30 16:42:39 +00:00
// Give the minimal size to the dialog, which allows displaying any page
wxSize minsize;
2015-03-30 16:42:39 +00:00
for( unsigned ii = 0; ii < m_pages.size(); ii++ )
{
2015-03-30 16:42:39 +00:00
wxSize size = m_pages[ii]->GetSizer()->CalcMin();
minsize.x = std::max( minsize.x, size.x );
minsize.y = std::max( minsize.y, size.y );
}
2015-03-30 16:42:39 +00:00
SetMinSize( minsize );
SetPageSize( minsize );
GetSizer()->SetSizeHints( this );
Center();
2015-03-30 16:42:39 +00:00
if( !m_radioAddGithub->GetValue() && !m_radioAddLocal->GetValue() )
m_radioAddLocal->SetValue( true );
2015-03-30 16:42:39 +00:00
setupDialogOrder();
updateGithubControls();
Connect( wxEVT_RADIOBUTTON, wxCommandEventHandler( WIZARD_FPLIB_TABLE::OnSourceCheck ), NULL, this );
Connect( wxEVT_DIRCTRL_SELECTIONCHANGED, wxCommandEventHandler( WIZARD_FPLIB_TABLE::OnSelectFiles ), NULL, this );
Connect( wxEVT_CHECKLISTBOX, wxCommandEventHandler( WIZARD_FPLIB_TABLE::OnCheckGithubList ), NULL, this );
}
2015-03-30 16:42:39 +00:00
WIZARD_FPLIB_TABLE::~WIZARD_FPLIB_TABLE()
{
// Use this if you want to store kicad lib URL in pcbnew/cvpcb section config:
// wxConfigBase* cfg = Kiface().KifaceSettings();
2015-03-30 16:42:39 +00:00
// Use this if you want to store kicad lib URL in common section config:
wxConfigBase* cfg = Pgm().CommonSettings();
cfg->Write( KICAD_FPLIBS_URL_KEY, GetGithubURL() );
}
2015-03-30 16:42:39 +00:00
WIZARD_FPLIB_TABLE::LIB_SOURCE WIZARD_FPLIB_TABLE::GetLibSource() const
{
if( m_radioAddGithub->GetValue() )
return GITHUB;
2015-03-30 16:42:39 +00:00
wxASSERT( m_radioAddLocal->GetValue() );
2015-03-30 16:42:39 +00:00
return LOCAL;
}
2015-03-30 16:42:39 +00:00
WIZARD_FPLIB_TABLE::LIB_SCOPE WIZARD_FPLIB_TABLE::GetLibScope() const
{
2015-03-30 16:42:39 +00:00
if( m_radioGlobal->GetValue() )
return GLOBAL;
2015-03-30 16:42:39 +00:00
wxASSERT( m_radioProject->GetValue() );
2015-03-30 16:42:39 +00:00
return PROJECT;
}
2015-03-30 16:42:39 +00:00
void WIZARD_FPLIB_TABLE::OnPageChanged( wxWizardEvent& aEvent )
{
SetBitmap( KiBitmap( wizard_add_fplib_icon_xpm ) );
enableNext( true );
#ifdef BUILD_GITHUB_PLUGIN
2015-03-30 16:42:39 +00:00
if( GetCurrentPage() == m_githubListDlg )
setupGithubList();
else
#endif
if( GetCurrentPage() == m_fileSelectDlg )
2015-03-30 16:42:39 +00:00
setupFileSelect();
else if( GetCurrentPage() == m_reviewDlg )
setupReview();
}
2015-03-30 16:42:39 +00:00
void WIZARD_FPLIB_TABLE::OnSelectFiles( wxCommandEvent& aEvent )
{
int filterIdx = m_filePicker->GetFilterIndex();
2015-03-30 16:42:39 +00:00
if( m_selectedFilter != filterIdx )
{
2015-03-30 16:42:39 +00:00
m_selectedFilter = filterIdx;
2015-03-30 16:42:39 +00:00
// Process the event again, as in the first iteration we cannot get the list of selected items
wxCommandEvent ev( wxEVT_DIRCTRL_SELECTIONCHANGED );
AddPendingEvent( ev );
return;
}
2015-03-30 16:42:39 +00:00
enableNext( checkFiles() );
}
2015-03-30 16:42:39 +00:00
void WIZARD_FPLIB_TABLE::OnCheckGithubList( wxCommandEvent& aEvent )
{
2015-03-30 16:42:39 +00:00
wxArrayInt dummy;
2015-03-30 16:42:39 +00:00
enableNext( m_checkListGH->GetCheckedItems( dummy ) > 0 );
}
2015-03-30 16:42:39 +00:00
void WIZARD_FPLIB_TABLE::OnSourceCheck( wxCommandEvent& aEvent )
{
updateGithubControls();
setupDialogOrder();
}
2015-03-30 16:42:39 +00:00
void WIZARD_FPLIB_TABLE::OnSelectAllGH( wxCommandEvent& aEvent )
{
2015-03-30 16:42:39 +00:00
for( unsigned int i = 0; i < m_checkListGH->GetCount(); ++i )
m_checkListGH->Check( i, true );
2015-03-30 16:42:39 +00:00
// The list might be empty, e.g. in case of download error
wxArrayInt dummy;
enableNext( m_checkListGH->GetCheckedItems( dummy ) > 0 );
}
2015-03-30 16:42:39 +00:00
void WIZARD_FPLIB_TABLE::OnUnselectAllGH( wxCommandEvent& aEvent )
{
2015-03-30 16:42:39 +00:00
for( unsigned int i = 0; i < m_checkListGH->GetCount(); ++i )
m_checkListGH->Check( i, false );
2015-03-30 16:42:39 +00:00
enableNext( false );
}
2015-03-30 16:42:39 +00:00
void WIZARD_FPLIB_TABLE::OnChangeSearch( wxCommandEvent& aEvent )
{
wxString searchPhrase = m_searchCtrlGH->GetValue().Lower();
2015-03-30 16:42:39 +00:00
// Store the current selection
wxArrayInt checkedIndices;
m_checkListGH->GetCheckedItems( checkedIndices );
wxArrayString checkedStrings;
2015-03-30 16:42:39 +00:00
for( unsigned int i = 0; i < checkedIndices.GetCount(); ++i )
checkedStrings.Add( m_checkListGH->GetString( checkedIndices[i] ).AfterLast( '/' ) );
2015-03-30 16:42:39 +00:00
m_checkListGH->Clear();
2015-03-30 16:42:39 +00:00
// Rebuild the list, putting the matching entries on the top
int matching = 0; // number of entries matching the search phrase
for( unsigned int i = 0; i < m_githubLibs.GetCount(); ++i )
{
const wxString& lib = m_githubLibs[i].AfterLast( '/' );
bool wasChecked = ( checkedStrings.Index( lib ) != wxNOT_FOUND );
int insertedIdx = -1;
if( !searchPhrase.IsEmpty() && lib.Lower().Contains( searchPhrase ) )
{
2015-03-30 16:42:39 +00:00
insertedIdx = m_checkListGH->Insert( lib, matching++ );
m_checkListGH->SetSelection( insertedIdx );
}
else
2015-03-30 16:42:39 +00:00
insertedIdx = m_checkListGH->Append( lib );
if( wasChecked )
m_checkListGH->Check( insertedIdx );
}
2015-03-30 16:42:39 +00:00
if( !m_checkListGH->IsEmpty() )
m_checkListGH->EnsureVisible( 0 );
}
2015-03-30 16:42:39 +00:00
void WIZARD_FPLIB_TABLE::OnWizardFinished( wxWizardEvent& aEvent )
{
#ifdef BUILD_GITHUB_PLUGIN
2015-03-30 16:42:39 +00:00
// Shall we download a localy copy of the libraries
if( GetLibSource() == GITHUB && m_downloadGithub->GetValue() )
{
2015-03-30 16:42:39 +00:00
wxString error;
wxArrayString libs;
2015-03-30 16:42:39 +00:00
// Prepare a list of libraries to download
for( std::vector<LIBRARY>::const_iterator it = m_libraries.begin();
it != m_libraries.end(); ++it )
{
wxASSERT( it->GetPluginType() == IO_MGR::GITHUB );
2015-03-30 16:42:39 +00:00
if( it->GetStatus() != LIBRARY::INVALID )
libs.Add( it->GetAbsolutePath() );
}
2015-03-30 16:42:39 +00:00
if( !downloadGithubLibsFromList( libs, &error ) )
{
2015-03-30 16:42:39 +00:00
DisplayError( this, error );
m_libraries.clear();
}
else
{
2015-03-30 16:42:39 +00:00
// Now libraries are stored locally, so update the paths to point to the download folder
for( std::vector<LIBRARY>::iterator it = m_libraries.begin();
it != m_libraries.end(); ++it )
{
2015-03-30 16:42:39 +00:00
wxString path = it->GetAbsolutePath();
path.Replace( GetGithubURL(), getDownloadDir() );
it->setPath( path );
it->setPluginType( IO_MGR::KICAD );
}
}
}
#endif
}
2015-03-30 16:42:39 +00:00
void WIZARD_FPLIB_TABLE::OnBrowseButtonClick( wxCommandEvent& aEvent )
{
2015-03-30 16:42:39 +00:00
wxString path = getDownloadDir();
2015-03-30 16:42:39 +00:00
path = wxDirSelector( _("Choose a folder to save the downloaded libraries" ),
path, 0, wxDefaultPosition, this );
2015-03-30 16:42:39 +00:00
if( !path.IsEmpty() && wxDirExists( path ) )
{
2015-03-30 16:42:39 +00:00
setDownloadDir( path );
wxConfigBase* cfg = Pgm().CommonSettings();
cfg->Write( KICAD_FPLIBS_LAST_DOWNLOAD_DIR, path );
2015-03-30 16:42:39 +00:00
updateGithubControls();
}
2015-03-30 16:42:39 +00:00
}
2015-03-30 16:42:39 +00:00
void WIZARD_FPLIB_TABLE::OnCheckSaveCopy( wxCommandEvent& aEvent )
{
updateGithubControls();
}
2015-03-30 16:42:39 +00:00
bool WIZARD_FPLIB_TABLE::checkFiles() const
{
2015-03-30 16:42:39 +00:00
// Get current selection (files & directories)
wxArrayString candidates;
m_filePicker->GetPaths( candidates );
2015-03-30 16:42:39 +00:00
// Workaround, when you change filters "/" is automatically selected
int slash_index = candidates.Index( "/", true, true );
if( slash_index != wxNOT_FOUND )
candidates.RemoveAt( slash_index, 1 );
2015-03-30 16:42:39 +00:00
if( candidates.IsEmpty() )
return false;
2015-03-30 16:42:39 +00:00
// Verify all the files/folders comply to the selected library type filter
for( unsigned int i = 0; i < candidates.GetCount(); ++i )
{
if( !passesFilter( candidates[i], m_filePicker->GetFilterIndex() ) )
return false;
}
2015-03-30 16:42:39 +00:00
return true;
}
2015-03-30 16:42:39 +00:00
#ifdef BUILD_GITHUB_PLUGIN
void WIZARD_FPLIB_TABLE::getLibsListGithub( wxArrayString& aList )
{
wxBeginBusyCursor();
2015-01-16 08:10:23 +00:00
// Be sure there is no trailing '/' at the end of the repo name
wxString git_url = m_textCtrlGithubURL->GetValue();
2015-03-30 16:42:39 +00:00
if( git_url.EndsWith( wxT( "/" ) ) )
2015-01-16 08:10:23 +00:00
{
git_url.RemoveLast();
m_textCtrlGithubURL->SetValue( git_url );
}
GITHUB_GETLIBLIST getter( git_url );
getter.GetFootprintLibraryList( aList );
2015-01-16 08:10:23 +00:00
wxEndBusyCursor();
}
// Download the .pretty libraries found in aUrlLis and store them on disk
// in a master folder
bool WIZARD_FPLIB_TABLE::downloadGithubLibsFromList( wxArrayString& aUrlList,
2015-03-30 16:42:39 +00:00
wxString* aErrorMessage )
{
// Display a progress bar to show the downlaod state
2015-03-30 16:42:39 +00:00
wxProgressDialog pdlg( _( "Downloading libraries" ), wxEmptyString, aUrlList.GetCount() );
// Download libs:
for( unsigned ii = 0; ii < aUrlList.GetCount(); ii++ )
{
wxString& libsrc_name = aUrlList[ii];
wxString libdst_name;
// Extract the lib name from the full URL:
wxURI url( libsrc_name );
wxFileName fn( url.GetPath() );
// Set our local path
2015-03-30 16:42:39 +00:00
fn.SetPath( getDownloadDir() );
libdst_name = fn.GetFullPath();
if( !wxDirExists( libdst_name ) )
wxMkdir( libdst_name );
2015-03-30 16:42:39 +00:00
pdlg.Update( ii, libsrc_name );
pdlg.Refresh();
pdlg.Update();
try
{
PLUGIN::RELEASER src( IO_MGR::PluginFind( IO_MGR::GITHUB ) );
PLUGIN::RELEASER dst( IO_MGR::PluginFind( IO_MGR::KICAD ) );
wxArrayString footprints = src->FootprintEnumerate( libsrc_name );
for( unsigned i = 0; i < footprints.size(); ++i )
{
std::unique_ptr<MODULE> m( src->FootprintLoad( libsrc_name, footprints[i] ) );
dst->FootprintSave( libdst_name, m.get() );
// m is deleted here by unique_ptr.
}
}
catch( const IO_ERROR& ioe )
{
if( aErrorMessage )
2015-03-30 16:42:39 +00:00
aErrorMessage->Printf( _( "Error:\n'%s'\nwhile downloading library:\n'%s'" ),
GetChars( ioe.errorText ), GetChars( libsrc_name ) );
return false;
}
}
return true;
}
void WIZARD_FPLIB_TABLE::setupGithubList()
{
// Enable 'Next' only if there is at least one library selected
wxArrayInt checkedIndices;
m_checkListGH->GetCheckedItems( checkedIndices );
enableNext( checkedIndices.GetCount() > 0 );
// Update only if necessary
if( m_githubLibs.GetCount() == 0 )
getLibsListGithub( m_githubLibs );
m_searchCtrlGH->Clear();
// Clear the review list so it will be reloaded
m_libraries.clear();
m_listCtrlReview->DeleteAllItems();
}
2015-03-30 16:42:39 +00:00
#endif /* BUILD_GITHUB_PLUGIN */
void WIZARD_FPLIB_TABLE::updateGithubControls()
{
#ifndef BUILD_GITHUB_PLUGIN
m_radioAddGithub->Enable( false );
#endif
2015-03-30 16:42:39 +00:00
// Disable inputs that have no meaning for the selected source
bool githubEnabled = ( GetLibSource() == GITHUB );
m_textCtrlGithubURL->Enable( githubEnabled );
m_downloadGithub->Enable( githubEnabled );
m_downloadDir->Enable( githubEnabled && wantLocalCopy() );
m_btnBrowse->Enable( githubEnabled && wantLocalCopy() );
bool valid = !( githubEnabled && wantLocalCopy() ) || wxFileName::IsDirWritable( getDownloadDir() );
// Do not allow to go further unless there is a valid directory selected
m_invalidDir->Show( !valid );
enableNext( valid );
}
void WIZARD_FPLIB_TABLE::updateLibraries()
{
// No need to update, the review list is ready
if( m_listCtrlReview->GetItemCount() != 0 )
return;
switch( GetLibSource() )
{
case LOCAL:
{
wxArrayString libs;
m_filePicker->GetPaths( libs );
// Workaround, when you change filters "/" is automatically selected
int slash_index = libs.Index( "/", true, true );
if( slash_index != wxNOT_FOUND )
libs.RemoveAt( slash_index, 1 );
m_libraries.reserve( libs.GetCount() );
for( unsigned int i = 0; i < libs.GetCount(); ++i )
m_libraries.push_back( libs[i] );
}
break;
case GITHUB:
{
wxArrayInt checkedLibs;
m_checkListGH->GetCheckedItems( checkedLibs );
m_libraries.reserve( checkedLibs.GetCount() );
for( unsigned int i = 0; i < checkedLibs.GetCount(); ++i )
m_libraries.push_back( GetGithubURL() + "/" + m_checkListGH->GetString( checkedLibs[i] ) );
}
break;
default:
wxASSERT( false );
break;
}
}
void WIZARD_FPLIB_TABLE::setupDialogOrder()
{
// Alternate the wizard pages flow depending on the selected option
switch( GetLibSource() )
{
case LOCAL:
m_welcomeDlg->SetNext( m_fileSelectDlg );
m_fileSelectDlg->SetPrev( m_welcomeDlg );
m_fileSelectDlg->SetNext( m_reviewDlg );
m_reviewDlg->SetPrev( m_fileSelectDlg );
break;
case GITHUB:
m_welcomeDlg->SetNext( m_githubListDlg );
m_githubListDlg->SetPrev( m_welcomeDlg );
m_githubListDlg->SetNext( m_reviewDlg );
m_reviewDlg->SetPrev( m_githubListDlg );
break;
default:
wxASSERT( false );
break;
}
}
void WIZARD_FPLIB_TABLE::setupFileSelect()
{
// Disable the button until something is selected
enableNext( checkFiles() );
// Clear the review list so it will be reloaded
m_libraries.clear();
m_listCtrlReview->DeleteAllItems();
}
void WIZARD_FPLIB_TABLE::setupReview()
{
wxBeginBusyCursor();
updateLibraries();
int libTotalCount = m_libraries.size();
int libCount = 0;
bool validate = true;
wxProgressDialog progressDlg( _( "Please wait..." ), _( "Validating libraries" ),
libTotalCount, this,
wxPD_APP_MODAL | wxPD_CAN_ABORT | wxPD_AUTO_HIDE );
m_dvLibName->SetWidth( 280 );
// Prepare the review list
m_listCtrlReview->DeleteAllItems();
for( std::vector<LIBRARY>::iterator it = m_libraries.begin(); it != m_libraries.end(); ++it )
{
wxVector<wxVariant> row;
LIBRARY::STATUS status = it->GetStatus();
// Check if the library contents is valid
if( status == LIBRARY::NOT_CHECKED && validate )
{
it->Test();
status = it->GetStatus();
}
row.push_back( wxVariant( it->GetDescription() ) );
switch( it->GetStatus() )
{
case LIBRARY::NOT_CHECKED:
row.push_back( wxVariant( _( "NOT CHECKED" ) ) );
break;
case LIBRARY::OK:
row.push_back( wxVariant( _( "OK" ) ) );
break;
case LIBRARY::INVALID:
row.push_back( wxVariant( _( "INVALID" ) ) );
break;
}
row.push_back( wxVariant( it->GetPluginName() ) );
m_listCtrlReview->AppendItem( row );
++libCount;
if( !progressDlg.Update( libCount, wxString::Format( _( "Validating libraries %d/%d" ),
libCount, libTotalCount ) ) )
validate = false;
}
// The list should never be empty, but who knows?
enableNext( m_listCtrlReview->GetItemCount() > 0 );
wxEndBusyCursor();
}