FEATURE: admin/user exports are compressed using the zip format (#7784)

FEATURE: admin/user exports are compressed using the zip format (#7784)

  • FEATURE: admin/user exports are compressed using the zip format

  • Update translations. Theme exporter now exports .zip file. Theme importer supports .zip and .gz files

  • Fix controller test, updated locale and skip saving the csv export to disk

diff --git a/Gemfile b/Gemfile
index b7507fe..85cabaf 100644
--- a/Gemfile
+++ b/Gemfile
@@ -203,6 +203,8 @@ gem "sassc-rails"
 gem 'rotp'
 gem 'rqrcode'
 
+gem 'rubyzip', require: false
+
 gem 'sshkey', require: false
 
 gem 'rchardet', require: false
diff --git a/Gemfile.lock b/Gemfile.lock
index b81b19f..f0faf02 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -351,6 +351,7 @@ GEM
       guess_html_encoding (>= 0.0.4)
       nokogiri (>= 1.6.0)
     ruby_dep (1.5.0)
+    rubyzip (1.2.3)
     safe_yaml (1.0.5)
     sanitize (5.0.0)
       crass (~> 1.0.2)
@@ -516,6 +517,7 @@ DEPENDENCIES
   rubocop
   ruby-prof
   ruby-readability
+  rubyzip
   sanitize
   sassc
   sassc-rails
diff --git a/app/assets/javascripts/admin/templates/modal/admin-install-theme.hbs b/app/assets/javascripts/admin/templates/modal/admin-install-theme.hbs
index 153dbc9..9a1e18d 100644
--- a/app/assets/javascripts/admin/templates/modal/admin-install-theme.hbs
+++ b/app/assets/javascripts/admin/templates/modal/admin-install-theme.hbs
@@ -44,7 +44,7 @@
 
     {{#if local}}
       <div class="inputs">
-        <input onchange={{action "uploadLocaleFile"}} type="file" id="file-input" accept='.dcstyle.json,application/json,.tar.gz,application/x-gzip'><br>
+        <input onchange={{action "uploadLocaleFile"}} type="file" id="file-input" accept='.dcstyle.json,application/json,.tar.gz,application/x-gzip,.tar.zip,application/zip'><br>
         <span class="description">{{i18n 'admin.customize.theme.import_file_tip'}}</span>
       </div>
     {{/if}}
diff --git a/app/controllers/admin/themes_controller.rb b/app/controllers/admin/themes_controller.rb
index 5389269..4def5bd 100644
--- a/app/controllers/admin/themes_controller.rb
+++ b/app/controllers/admin/themes_controller.rb
@@ -88,7 +88,7 @@ class Admin::ThemesController < Admin::AdminController
       rescue RemoteTheme::ImportError => e
         render_json_error e.message
       end
-    elsif params[:bundle] || (params[:theme] && ["application/x-gzip", "application/gzip"].include?(params[:theme].content_type))
+    elsif params[:bundle] || (params[:theme] && ["application/x-gzip", "application/gzip", "application/zip"].include?(params[:theme].content_type))
       # params[:bundle] used by theme CLI. params[:theme] used by admin UI
       bundle = params[:bundle] || params[:theme]
       theme_id = params[:theme_id]
@@ -252,6 +252,7 @@ class Admin::ThemesController < Admin::AdminController
 
     exporter = ThemeStore::TgzExporter.new(@theme)
     file_path = exporter.package_filename
+
     headers['Content-Length'] = File.size(file_path).to_s
     send_data File.read(file_path),
       filename: File.basename(file_path),
diff --git a/app/jobs/regular/export_csv_file.rb b/app/jobs/regular/export_csv_file.rb
index e1b5739..d8d3a72 100644
--- a/app/jobs/regular/export_csv_file.rb
+++ b/app/jobs/regular/export_csv_file.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'csv'
+require 'zip'
 require_dependency 'system_message'
 require_dependency 'upload_creator'
 
@@ -53,18 +54,19 @@ module Jobs
       # ensure directory exists
       FileUtils.mkdir_p(UserExport.base_directory) unless Dir.exists?(UserExport.base_directory)
 
-      # write to CSV file
-      CSV.open(absolute_path, "w") do |csv|
+      # Generate a compressed CSV file
+      csv_to_export = CSV.generate do |csv|
         csv << get_header if @entity != "report"
         public_send(export_method).each { |d| csv << d }
       end
 
-      # compress CSV file
-      system('gzip', '-5', absolute_path)
+      compressed_file_path = "#{absolute_path}.zip"
+      Zip::File.open(compressed_file_path, Zip::File::CREATE) do |zipfile|
+        zipfile.get_output_stream(file_name) { |f| f.puts csv_to_export }
+      end
 
       # create upload
       upload = nil
-      compressed_file_path = "#{absolute_path}.gz"
 
       if File.exist?(compressed_file_path)
         File.open(compressed_file_path) do |file|
diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml
index aad6399..d450f80 100644
--- a/config/locales/client.en.yml
+++ b/config/locales/client.en.yml
@@ -3514,7 +3514,7 @@ en:
           delete_upload_confirm: "Delete this upload? (Theme CSS may stop working!)"
           import_web_tip: "Repository containing theme"
           import_web_advanced: "Advanced..."
-          import_file_tip: ".tar.gz or .dcstyle.json file containing theme"
+          import_file_tip: ".tar.gz, .tar.zip, or .dcstyle.json file containing theme"
           is_private: "Theme is in a private git repository"
           remote_branch: "Branch name (optional)"
           public_key: "Grant the following public key access to the repo:"
diff --git a/config/locales/server.en.yml b/config/locales/server.en.yml
index 74a2b8e..014c84b 100644
--- a/config/locales/server.en.yml
+++ b/config/locales/server.en.yml
@@ -2668,7 +2668,7 @@ en:
 
         The above download link will be valid for 48 hours.
 
-        The data is compressed as a gzip archive. If the archive does not extract itself when you open it, use the tools recommended here: https://www.gzip.org/#faq4
+        The data is compressed as a zip archive. If the archive does not extract itself when you open it, use the tool recommended here: https://www.7-zip.org/
 
     csv_export_failed:
       title: "CSV Export Failed"
diff --git a/config/site_settings.yml b/config/site_settings.yml
index 1a9fbb9..f29155b 100644
--- a/config/site_settings.yml
+++ b/config/site_settings.yml
@@ -1048,7 +1048,7 @@ files:
     list_type: compact
   export_authorized_extensions:
     hidden: true
-    default: "gz"
+    default: "zip"
     type: list
     list_type: compact
   responsive_post_image_sizes:
diff --git a/lib/theme_store/tgz_exporter.rb b/lib/theme_store/tgz_exporter.rb
index 824a874..d0d8cef 100644
--- a/lib/theme_store/tgz_exporter.rb
+++ b/lib/theme_store/tgz_exporter.rb
@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'zip'
+
 module ThemeStore; end
 
 class ThemeStore::TgzExporter
@@ -58,11 +60,19 @@ class ThemeStore::TgzExporter
   private
   def export_package
     export_to_folder
+
     Dir.chdir(@temp_folder) do
       tar_filename = "#{@export_name}.tar"
       Discourse::Utils.execute_command('tar', '--create', '--file', tar_filename, @export_name, failure_message: "Failed to tar theme.")
-      Discourse::Utils.execute_command('gzip', '-5', tar_filename, failure_message: "Failed to gzip archive.")
-      "#{@temp_folder}/#{tar_filename}.gz"
+
+      zip_filename = "#{tar_filename}.zip"
+      absolute_path = "#{@temp_folder}/#{tar_filename}"
+      Zip::File.open(zip_filename, Zip::File::CREATE) do |zipfile|
+        zipfile.add(tar_filename, absolute_path)
+        zipfile.close
+      end
+
+      "#{absolute_path}.zip"
     end
   end
 
diff --git a/lib/theme_store/tgz_importer.rb b/lib/theme_store/tgz_importer.rb
index 5dfb071..e6198ee 100644
--- a/lib/theme_store/tgz_importer.rb
+++ b/lib/theme_store/tgz_importer.rb
@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'zip'
+
 module ThemeStore; end
 
 class ThemeStore::TgzImporter
@@ -13,8 +15,21 @@ class ThemeStore::TgzImporter
 
   def import!
     FileUtils.mkdir(@temp_folder)
-    Dir.chdir(@temp_folder) do
-      Discourse::Utils.execute_command("tar", "-xzvf", @filename, "--strip", "1")
+
+    if @filename.include?('.zip')
+      name = @filename.split('/').last.gsub('.zip', '')
+
+      Dir.chdir(@temp_folder) do
+        Zip::File.open(@filename) do |zip_file|
+          zip_file.each { |entry| entry.extract(name) }
+        end
+
+        Discourse::Utils.execute_command("tar", "-xvf", name, "--strip", "1")
+      end
+    else
+      Dir.chdir(@temp_folder) do
+        Discourse::Utils.execute_command("tar", "-xzvf", @filename, "--strip", "1")
+      end
     end
   rescue RuntimeError
     raise RemoteTheme::ImportError, I18n.t("themes.import_error.unpack_failed")
diff --git a/spec/components/theme_store/tgz_exporter_spec.rb b/spec/components/theme_store/tgz_exporter_spec.rb

[... diff too long, it was truncated ...]

GitHub sha: 8b2580e2

.tar.zip seems unusual… does this also work with regular .zip files created using the windows/mac UI?

1 Like

Hmm no, it won’t. I think it makes more sense to support plain .zip instead of .tar.zip

1 Like

Definitely, let’s drop .tar.zip

3 Likes

Revert "FEATURE: admin/user exports are compressed using the zip format (#7784)"