1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
|
/*
Copyright (©) 2003-2025 Teus Benschop.
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, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include <export/usfm.h>
#include <export/logic.h>
#include <tasks/logic.h>
#include <database/bibles.h>
#include <database/books.h>
#include <database/logs.h>
#include <database/config/bible.h>
#include <database/state.h>
#include <filter/url.h>
#include <filter/string.h>
#include <filter/roles.h>
#include <filter/text.h>
#include <filter/archive.h>
#include <filter/shell.h>
#include <locale/translate.h>
#include <styles/sheets.h>
void export_usfm (std::string bible, bool log)
{
// Root USFM directory, plus info file.
std::string usfmDirectory = export_logic::usfm_directory (bible, 2);
if (!file_or_dir_exists (usfmDirectory)) filter_url_mkdir (usfmDirectory);
std::string infopath = filter_url_create_root_path ({"export", "usfm.html"});
std::string infocontents = filter_url_file_get_contents (infopath);
infopath = filter_url_create_path ({usfmDirectory, "readme.html"});
filter_url_file_put_contents (infopath, infocontents);
// USFM directories
std::string usfmDirectoryFull = export_logic::usfm_directory (bible, 0);
if (!file_or_dir_exists (usfmDirectoryFull)) filter_url_mkdir (usfmDirectoryFull);
// Take the USFM from the Bible database.
// Generate one USFM file per book.
std::vector <int> books = database::bibles::get_books (bible);
for (auto book : books) {
// If the USFM output is zipped, the zipping process removes the individual USFM files,
// which means that they are no longer found, which triggers a new export.
// The USFM data of the current book.
std::string bookUsfmDataFull;
// Collect the USFM for all chapters in this book.
std::vector <int> chapters = database::bibles::get_chapters (bible, book);
for (auto chapter : chapters) {
// Get the USFM code for the current chapter.
std::string chapter_data = database::bibles::get_chapter (bible, book, chapter);
chapter_data = filter::strings::trim (chapter_data);
// Add the chapter USFM code to the book's USFM code.
bookUsfmDataFull += chapter_data;
bookUsfmDataFull += "\n";
}
// Save the USFM of this book to a file with a localized name.
std::string base_book_filename = export_logic::base_book_filename (bible, book);
std::string path = filter_url_create_path ({usfmDirectoryFull, base_book_filename + ".usfm"});
filter_url_file_put_contents (path, bookUsfmDataFull);
// Clear the flag that indicated this export.
Database_State::clearExport (bible, book, export_logic::export_full_usfm);
if (log) Database_Logs::log (translate("Exported to USFM") + ": " + bible + " " + database::books::get_english_from_id (static_cast<book_id>(book)), roles::translator);
}
// Base name of the zip file.
std::string zipfile = export_logic::base_book_filename (bible, 0) + ".zip";
std::string zippath = filter_url_create_path ({usfmDirectoryFull, zipfile});
// Compress USFM files into one zip file.
filter_url_unlink (zippath);
std::string archive = filter_archive_zip_folder (usfmDirectoryFull);
filter_url_rename (archive, zippath);
if (database::config::bible::get_secure_usfm_export (bible)) {
// Securing the full USFM export means that there will be one zip file secured with a password.
// This zip file contains all exported USFM data.
// All other files will be removed.
// It uses the external zip binary.
std::vector <std::string> files = filter_url_scandir (usfmDirectoryFull);
for (auto file : files) {
if (file != zipfile) filter_url_unlink (filter_url_create_path ({usfmDirectoryFull, file}));
}
std::string password = database::config::bible::get_export_password (bible);
std::string output, error;
filter::shell::run (usfmDirectoryFull, filter::shell::get_executable(filter::shell::Executable::zip), {"-P", password, "bible.zip", zipfile}, &output, &error);
filter_url_unlink (zippath);
filter_url_rename (filter_url_create_path ({usfmDirectoryFull, "bible.zip"}), zippath);
}
// Clear the flag that indicated this export.
Database_State::clearExport (bible, 0, export_logic::export_full_usfm);
if (log) Database_Logs::log (translate("Exported to USFM") + ": " + bible + " " + translate("All books"), roles::translator);
}
|