KiCad PCB EDA Suite
Loading...
Searching...
No Matches
jobs_output_archive.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2024 Mark Roszko <[email protected]>
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software: you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation, either version 3 of the License, or (at your
10 * option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
22#include <wx/fs_zip.h>
23#include <wx/wfstream.h>
24#include <wx/zipstrm.h>
25#include <gestfich.h>
26#include <common.h>
28
34
35
37{
38 if( m_outputPath.IsEmpty() )
39 return false;
40
41 return true;
42}
43
44
45bool JOBS_OUTPUT_ARCHIVE::HandleOutputs( const wxString& baseTempPath, PROJECT* aProject,
46 const std::vector<JOB_OUTPUT>& aOutputsToHandle )
47{
48 bool success = true;
49
50 wxString outputPath = ExpandTextVars( m_outputPath, aProject );
51 outputPath = ExpandEnvVarSubstitutions( outputPath, aProject );
52
53 if( outputPath.StartsWith( "~" ) )
54 outputPath.Replace( "~", wxGetHomeDir(), false );
55
56 outputPath = EnsureFileExtension( outputPath, FILEEXT::ArchiveFileExtension );
57
58 wxFFileOutputStream ostream( outputPath );
59
60 if( !ostream.IsOk() ) // issue to create the file. Perhaps not writable dir
61 {
62 //msg.Printf( _( "Failed to create file '%s'." ), aDestFile );
63 //aReporter.Report( msg, RPT_SEVERITY_ERROR );
64 return false;
65 }
66
67 wxZipOutputStream zipstream( ostream, -1, wxConvUTF8 );
68 wxString errors;
69
70 if( !AddDirectoryToZip( zipstream, baseTempPath, errors ) )
71 success = false;
72
73 if( !zipstream.Close() )
74 success = false;
75
76 return success;
77}
78
79
80void JOBS_OUTPUT_ARCHIVE::FromJson( const nlohmann::json& j )
81{
82 m_outputPath = j.value( "output_path", "" );
84}
85
86
87void JOBS_OUTPUT_ARCHIVE::ToJson( nlohmann::json& j ) const
88{
89 j["output_path"] = m_outputPath;
90 j["format"] = "zip";
91}
92
93
95{
96 return _( "Archive" );
97}
bool OutputPrecheck() override
Checks if the output process can proceed before doing anything else This can include user prompts.
void FromJson(const nlohmann::json &j) override
void ToJson(nlohmann::json &j) const override
wxString GetDefaultDescription() const override
bool HandleOutputs(const wxString &aBaseTempPath, PROJECT *aProject, const std::vector< JOB_OUTPUT > &aOutputsToHandle) override
Container for project specific data.
Definition project.h:65
const wxString ExpandEnvVarSubstitutions(const wxString &aString, const PROJECT *aProject)
Replace any environment variable & text variable references with their values.
Definition common.cpp:355
wxString EnsureFileExtension(const wxString &aFilename, const wxString &aExtension)
It's annoying to throw up nag dialogs when the extension isn't right.
Definition common.cpp:429
wxString ExpandTextVars(const wxString &aSource, const PROJECT *aProject, int aFlags)
Definition common.cpp:59
The common library.
#define _(s)
bool AddDirectoryToZip(wxZipOutputStream &aZip, const wxString &aSourceDir, wxString &aErrors, const wxString &aParentDir)
Add a directory and its contents to a zip file.
Definition gestfich.cpp:547
static const std::string ArchiveFileExtension
Definition of file extensions used in Kicad.