kicad/common/gestfich.cpp

356 lines
10 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 2008 Wayne Stambaugh <stambaughw@gmail.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 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
*/
/**
* @file gestfich.cpp
* @brief Functions for file management
*/
#include <wx/mimetype.h>
#include <wx/filename.h>
#include <wx/dir.h>
#include <wx/filedlg.h>
#include <pgm_base.h>
#include <common.h>
#include <confirm.h>
#include <core/arraydim.h>
#include <gestfich.h>
void QuoteString( wxString& string )
{
if( !string.StartsWith( wxT( "\"" ) ) )
{
string.Prepend ( wxT( "\"" ) );
string.Append ( wxT( "\"" ) );
}
}
wxString FindKicadFile( const wxString& shortname )
{
// Test the presence of the file in the directory shortname of
// the KiCad binary path.
#ifndef __WXMAC__
wxString fullFileName = Pgm().GetExecutablePath() + shortname;
#else
wxString fullFileName = Pgm().GetExecutablePath() + wxT( "Contents/MacOS/" ) + shortname;
#endif
if( wxFileExists( fullFileName ) )
return fullFileName;
// Test the presence of the file in the directory shortname
// defined by the environment variable KiCad.
if( Pgm().IsKicadEnvVariableDefined() )
{
fullFileName = Pgm().GetKicadEnvVariable() + shortname;
if( wxFileExists( fullFileName ) )
return fullFileName;
}
#if defined( __WINDOWS__ )
// kicad can be installed highly portably on Windows, anywhere and concurrently
// either the "kicad file" is immediately adjacent to the exe or it's not a valid install
return shortname;
#endif
// Path list for KiCad binary files
const static wxChar* possibilities[] = {
#if defined( __WXMAC__ )
// all internal paths are relative to main bundle kicad.app
wxT( "Contents/Applications/pcbnew.app/Contents/MacOS/" ),
wxT( "Contents/Applications/eeschema.app/Contents/MacOS/" ),
wxT( "Contents/Applications/gerbview.app/Contents/MacOS/" ),
wxT( "Contents/Applications/bitmap2component.app/Contents/MacOS/" ),
wxT( "Contents/Applications/pcb_calculator.app/Contents/MacOS/" ),
wxT( "Contents/Applications/pl_editor.app/Contents/MacOS/" ),
#else
wxT( "/usr/bin/" ),
wxT( "/usr/local/bin/" ),
wxT( "/usr/local/kicad/bin/" ),
#endif
};
// find binary file from possibilities list:
for( unsigned i=0; i<arrayDim(possibilities); ++i )
{
#ifndef __WXMAC__
fullFileName = possibilities[i] + shortname;
#else
// make relative paths absolute
fullFileName = Pgm().GetExecutablePath() + possibilities[i] + shortname;
#endif
if( wxFileExists( fullFileName ) )
return fullFileName;
}
return shortname;
}
int ExecuteFile( const wxString& ExecFile, const wxString& param, wxProcess *callback )
{
wxString fullFileName;
wxString fullParams;
#ifdef __UNIX__
int space = ExecFile.Find( ' ' );
if( space > 0 && !ExecFile.Contains( "\"" ) && !ExecFile.Contains( "\'" ) )
{
fullFileName = FindKicadFile( ExecFile.Mid( 0, space ) );
fullParams = ExecFile.Mid( space + 1 ) + wxS( " " ) + param;
}
else
#endif
{
fullFileName = FindKicadFile( ExecFile );
fullParams = param;
}
if( wxFileExists( fullFileName ) )
{
if( !fullParams.IsEmpty() )
fullFileName += wxS( " " ) + fullParams;
return ProcessExecute( fullFileName, wxEXEC_ASYNC, callback );
}
#ifdef __WXMAC__
else
{
QuoteString( fullFileName );
if( !param.IsEmpty() )
fullFileName += wxT( " " ) + param;
return ProcessExecute( wxT( "/usr/bin/open -a " ) + fullFileName, wxEXEC_ASYNC, callback );
}
#else
else
{
wxString msg;
msg.Printf( _( "Command '%s' could not be found." ), fullFileName );
DisplayError( nullptr, msg, 20 );
return -1;
}
#endif
}
bool OpenPDF( const wxString& file )
{
wxString command;
wxString filename = file;
Pgm().ReadPdfBrowserInfos();
if( !Pgm().UseSystemPdfBrowser() ) // Run the preferred PDF Browser
{
#ifdef __WXMSW__
// Windows requires double quotes around the filename to handle spaces
command = Pgm().GetPdfBrowserName() + wxT( " \"" ) + filename + wxT( "\"" );
#else
command = Pgm().GetPdfBrowserName() + wxT( " '" ) + filename + wxT( "'" );
#endif
}
else
{
// wxLaunchDefaultApplication on Unix systems is run as an external process passing
// the filename to the appropriate application as a command argument.
// depending on wxWidgets version, spaces in the path and/or file name will cause
// argument parsing issues so always quote the filename and path.
// This is applicable to all Unix platforms with wxWidgets version < 3.1.0.
// See https://github.com/wxWidgets/wxWidgets/blob/master/src/unix/utilsx11.cpp#L2654
#ifdef __WXGTK__
#if !wxCHECK_VERSION( 3, 1, 0 )
// Quote in case there are spaces in the path.
// Not needed on 3.1.4, but needed in 3.0 versions
// Moreover, on Linux, on 3.1.4 wx version, adding quotes breaks wxLaunchDefaultApplication
QuoteString( filename );
#endif
#endif
if( wxLaunchDefaultApplication( filename ) )
return true;
#ifdef __WXMAC__
command = wxT( "/usr/bin/open -a '" ) + file + wxT( "'" );
#endif
// If launching the system default PDF viewer fails, fall through with empty command
// string so the error message is displayed.
}
if( !command.IsEmpty() )
{
if( ProcessExecute( command ) != -1 )
{
return true;
}
else
{
wxString msg;
msg.Printf( _( "Problem while running the PDF viewer.\nCommand is '%s'." ), command );
DisplayError( nullptr, msg );
}
}
else
{
wxString msg;
msg.Printf( _( "Unable to find a PDF viewer for '%s'." ), file );
DisplayError( nullptr, msg );
}
return false;
}
void OpenFile( const wxString& file )
{
wxFileName fileName( file );
wxFileType* filetype = wxTheMimeTypesManager->GetFileTypeFromExtension( fileName.GetExt() );
if( !filetype )
return;
wxString command;
wxFileType::MessageParameters params( file );
filetype->GetOpenCommand( &command, params );
delete filetype;
if( !command.IsEmpty() )
ProcessExecute( command );
}
bool doPrintFile( const wxString& file, bool aDryRun )
{
wxFileName fileName( file );
wxString ext = fileName.GetExt();
wxFileType* filetype = wxTheMimeTypesManager->GetFileTypeFromExtension( ext );
if( !filetype )
return false;
wxString printCommand;
wxString openCommand;
wxString application;
wxFileType::MessageParameters params( file );
filetype->GetPrintCommand( &printCommand, params );
filetype->GetOpenCommand( &openCommand, params );
delete filetype;
if( !printCommand.IsEmpty() )
{
if( !aDryRun )
ProcessExecute( printCommand );
return true;
}
#ifdef __WXMAC__
if( ext == "ps" || ext == "pdf" )
application = "Preview";
else if( ext == "csv" )
application = "Numbers";
else if( ext == "txt" || ext == "rpt" || ext == "pos" || ext == "cmp" || ext == "net" )
application = "TextEdit";
if( !application.IsEmpty() )
{
printCommand.Printf( "osascript -e 'tell application \"%s\"' "
"-e ' set srcFileRef to (open POSIX file \"%s\")' "
"-e ' activate' "
"-e ' print srcFileRef print dialog true' "
"-e 'end tell' ",
application,
file );
if( !aDryRun )
system( printCommand.c_str() );
return true;
}
#endif
#ifdef __WXGTK__
if( ext == "ps" || ext == "pdf"
|| ext == "csv"
|| ext == "txt" || ext == "rpt" || ext == "pos" || ext == "cmp" || ext == "net" )
{
printCommand.Printf( "lp \"%s\"", file );
if( !aDryRun )
ProcessExecute( printCommand );
return true;
}
#endif
if( !aDryRun )
{
DisplayError( nullptr, wxString::Format( _( "Cannot print '%s'.\n\nUnknown file type." ),
file ) );
}
return false;
}
void PrintFile( const wxString& file )
{
doPrintFile( file, false );
}
bool CanPrintFile( const wxString& file )
{
return doPrintFile( file, true );
}
void KiCopyFile( const wxString& aSrcPath, const wxString& aDestPath, wxString& aErrors )
{
if( !wxCopyFile( aSrcPath, aDestPath ) )
{
wxString msg;
if( !aErrors.IsEmpty() )
aErrors += "\n";
msg.Printf( _( "Cannot copy file '%s'." ), aDestPath );
aErrors += msg;
}
}
wxString QuoteFullPath( wxFileName& fn, wxPathFormat format )
{
return wxT( "\"" ) + fn.GetFullPath( format ) + wxT( "\"" );
}