Initial commit.

README.md

@@ -0,0 +1,3 @@
+# GlotPress Bulk Download Translations
+A plugin for [GlotPress as a WordPress plugin](https://github.com/deliciousbrains/GlotPress) that downloads all translation sets for a project as a single zip file.
+

bulk-download-translations.php

@@ -0,0 +1,178 @@
+<?php
+/*
+Plugin Name: GlotPress Bulk Download Translations
+Plugin URI: http://glot-o-matic.com/gp-bulk-download-translations
+Description: Download all the translation sets of a GlotPress project in a zip file at once.
+Version: 0.5
+Author: gregross
+Author URI: http://toolstack.com
+Tags: glotpress, glotpress plugin 
+License: GPLv2
+License URI: http://www.gnu.org/licenses/gpl-2.0.html
+*/
+
+class GP_Bulk_Download_Translations {
+	public $id = 'bulk-download-translations';
+
+	public function __construct() {
+		// We need the Zip class to do the bulk export, if it doesn't exist, don't bother enabling the plugin.
+		if( ! class_exists('ZipArchive') ) {
+			return;
+		}
+
+		add_action( 'gp_project_actions', array( $this, 'gp_project_actions' ), 10, 2 );
+
+		// We can't use the filter in the defaults route code because plugins don't load until after
+		// it has already run, so instead add the routes directly to the global GP_Router object.
+		GP::$router->add( "/bulk-export/(.+?)", array( $this, 'bulk_export' ), 'get' );
+		GP::$router->add( "/bulk-export/(.+?)", array( $this, 'bulk_export' ), 'post' );
+
+	}
+
+	public function gp_project_actions( $actions, $project ) {
+		$actions[] .= gp_link_get( gp_url( 'bulk-export/' . $project->slug), __('Bulk Export Translations') );
+
+		return $actions;
+	}
+
+	public function before_request() {
+	}
+
+	public function bulk_export( $project_path ) {
+		// The project path is url encoded, so decode before we do anything with it.
+		$project_path = urldecode( $project_path );
+
+		// Loop through the supported format options and determine which ones we're exporting.
+		$include_formats = array();
+		foreach ( GP::$formats as $slug => $format ) {
+			if( gp_const_get('GP_BULK_DOWNLOAD_TRANSLATIONS_FORMAT_' . strtoupper(str_replace('.', '-', $slug)), false) == true ) {
+				$include_formats[] = $slug;
+			}
+		}
+
+		// If we didn't have any formats set for export, use PO files by default.
+		if( count( $include_formats ) == 0 ) { $include_formats = array( 'po' ); }
+
+		// Determine our temporary directory.
+		$temp_dir = gp_const_get('GP_BULK_DOWNLOAD_TRANSLATIONS_TEMP_DIR', sys_get_temp_dir());
+
+		// Get a temporary file, use bdt as the first three letters of it.
+		$temp_dir = tempnam($temp_dir, 'bdt');
+
+		// Now delete the file and recreate it as a directory.
+		unlink( $temp_dir );
+		mkdir( $temp_dir );
+
+		// Create a project class to use to get the project object.
+		$project_class = new GP_Project;
+
+		// Get the project object from the project path that was passed in.
+		$project_obj = $project_class->by_path( $project_path );
+
+		// Get the translations sets from the project ID.
+		$translation_sets = GP::$translation_set->by_project_id( $project_obj->id );
+
+		// Setup an array to use to track the file names we're creating.
+		$files = array();
+
+		// Loop through all the sets.
+		foreach( $translation_sets as $set ) {
+			// Loop through all the formats we're exporting
+			foreach( $include_formats as $format ) {
+				// Export the PO file for this translation set.
+				$files[] .= $this->_export_to_file( $format, $temp_dir, $project_obj, $locale, $set );
+			}
+		}
+
+		// Setup the zip file name to use, it's the project name + .zip.
+		$zip_file = $temp_dir . '/' . $project_path . '.zip';
+
+		// Create the new archive.
+		$zip = new ZipArchive;
+		if ( $zip->open($zip_file, ZipArchive::CREATE) === TRUE ) {
+			// Loop through all of the files we created and add them to the zip file.
+			foreach( $files as $file ) {
+				// The first parameter is the full path to the local file, the second is the name as it will appear in the zip file.
+				// Note this does not actually write data to the zip file.
+				$zip->addFile($temp_dir . '/' . $file, $file);
+			}
+
+			// Close the zip file, this does the actual writing of the data.
+			$zip->close();
+		}
+
+		// Since we can't delete the export files until after we close the zip, loop through the files once more
+		// and delete them.
+		foreach( $files as $file ) {
+			unlink( $temp_dir . '/' . $file );
+		}
+
+		// Generate our headers for the file download.
+		$last_modified = gmdate( 'D, d M Y H:i:s' ) . ' GMT';
+		header('Content-Description: File Transfer');
+		header('Pragma: public');
+		header('Expires: 0');
+		header('Last-Modified: ' . $last_modified);
+		header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
+		header('Content-Disposition: attachment; filename=' . $project_path . '.zip');
+		header('Content-Type: application/octet-stream');
+		header('Connection: close');
+
+		// Write the zip file out to the client.
+		readfile( $zip_file );
+
+		// Delete the zip file.
+		unlink( $zip_file );
+
+		// Remove the temporary directory and we're done!
+		rmdir( $temp_dir );
+	}
+
+	private function _export_to_file( $format, $dir, $project, $locale, $set ) {
+		// Get the entries we going to export.
+		$entries = GP::$translation->for_export( $project, $set );
+
+		// Get the slug for this locale.
+		$locale_slug = $set->locale;
+
+		// Get the locale object by the slug.
+		$locale = GP_Locales::by_slug( $locale_slug );
+
+		// Apply any filters that other plugins may have implemented.
+		$export_locale = apply_filters( 'export_locale', $locale->slug, $locale );
+
+		// Get the format object to create the export with.
+		$format_obj = gp_array_get( GP::$formats, gp_get( 'format', $format ), null );
+
+		// Create the default file name.
+		$filename = sprintf( '%s-%s.'.$format_obj->extension, str_replace( '/', '-', $project->path ), $export_locale );
+
+		// Apply any filters that other plugins may have implemented to the filename.
+		$filename = apply_filters( 'export_filename', $filename, $project->path, $set->slug, $export_locale, $format_obj->extension );
+
+		// Get the contents from the formatter.
+		$contents = $format_obj->print_exported_file( $project, $locale, $set, $entries );
+
+		// Write the contents out to the file.
+		$fh = fopen( $dir . '/' . $filename, 'w' );
+		fwrite( $fh, $contents );
+		fclose( $fh );
+
+		// Return the filename for future reference.
+		return $filename;
+	}
+
+	public function after_request() {
+	}
+
+}
+
+// Add an action to WordPress's init hook to setup the plugin.  Don't just setup the plugin here as the GlotPress plugin may not have loaded yet.
+add_action( 'gp_init', 'gp_bulk_download_translations_init' );
+
+// This function creates the plugin.
+function gp_bulk_download_translations_init() {
+	GLOBAL $gp_bulk_download_translations;
+
+	$gp_bulk_download_translations = new GP_Bulk_Download_Translations;
+}

readme.txt

@@ -0,0 +1,56 @@
+=== GP Bulk Download Translations ===
+Contributors: gregross
+Donate link: http://toolstack.com/donate
+Plugin URI: http://glot-o-matic.com/gp-bulk-download-translations
+Author URI: http://toolstack.com
+Tags: translation, glotpress
+Requires at least: 4.4
+Tested up to: 4.4
+Stable tag: 0.5
+License: GPLv2
+License URI: http://www.gnu.org/licenses/gpl-2.0.html
+
+A plugin for [GlotPress as a WordPress plugin](https://github.com/deliciousbrains/GlotPress) that downloads all translation sets for a project as a single zip file.
+
+== Description ==
+
+A plugin for [GlotPress as a WordPress plugin](https://github.com/deliciousbrains/GlotPress) that downloads all translation sets for a project as a single zip file.
+
+== Installation ==
+
+Install from the WordPress plugin directory.
+
+By default PO files will be exported, you can set which formats will be exported by adding the following line to your wp-config.php file (only include those lines for the formats you wish to export):
+
+	define( 'GP_BULK_DOWNLOAD_TRANSLATIONS_FORMAT_PO', true );
+	define( 'GP_BULK_DOWNLOAD_TRANSLATIONS_FORMAT_MO', true );
+	define( 'GP_BULK_DOWNLOAD_TRANSLATIONS_FORMAT_ANDROID', true );
+	define( 'GP_BULK_DOWNLOAD_TRANSLATIONS_FORMAT_RESX', true );
+	define( 'GP_BULK_DOWNLOAD_TRANSLATIONS_FORMAT_STRINGS', true );
+
+	Note: If you have custom formats defined you can use 'GP_BULK_DOWNLOAD_TRANSLATIONS_FORMAT_[SLUG]' to include them (SLUG must be in upper case and any dashes replaced with underscores).
+
+You can also define the temporary directory to use by adding the following line to your gp-config.php file:
+
+	define( 'GP_BULK_DOWNLOAD_TRANSLATIONS_TEMP_DIR', 'c:/temp' );
+
+	Note: Do not include a trailing slash.
+
+== Frequently Asked Questions ==
+
+= TBD =
+
+TBD
+
+== Changelog ==
+
+= 1.0 =
+* Release Date: TBD
+* Initial release.
+
+== Upgrade Notice ==
+
+= 1.0 =
+
+Initial release, no upgrade notes at this time.
+