*7837* Email update SQL generator

docs/dev/RELEASE

@@ -5,7 +5,9 @@ The following steps (subject to change) are typically performed to prepare a new
 OJS release:
 
 
-1. Ensure that the "complete" flags in registry/locales.xml are accurate
+1. Ensure that the "complete" flags in registry/locales.xml are accurate. Use
+    the tools/genEmailUpdates.php script to generate email template update
+    SQL for subjects and bodies whose defaults have changed.
 
 
 2. Update version, installation, and upgrade descriptor files:

tools/genEmailUpdates.php

@@ -0,0 +1,115 @@
+<?php
+
+/**
+ * @file tools/genEmailUpdates.php
+ *
+ * Copyright (c) 2003-2012 John Willinsky
+ * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
+ *
+ * @class genEmailUpdates
+ * @ingroup tools
+ *
+ * @brief CLI tool to generate update scripts to upgrade any email texts that
+ * were modified since the last release.
+ */
+
+require(dirname(__FILE__) . '/bootstrap.inc.php');
+
+class genEmailUpdates extends CommandLineTool {
+	/** @var $oldTag string Name of the old git tag to use */
+	var $oldTag;
+
+	/** @var $oldTag string Name of the new git tag to use */
+	var $newTag;
+
+	/**
+	 * Constructor.
+	 * @param $argv array command-line arguments
+	 * 	If specified, the first argument should be the file to parse
+	 */
+	function genEmailUpdates($argv = array()) {
+		parent::CommandLineTool($argv);
+
+		if (count($argv) != 3) {
+			$this->usage();
+			exit(1);
+		}
+
+		$this->oldTag = $argv[1];
+		$this->newTag = $argv[2];
+	}
+
+	/**
+	 * Print command usage information.
+	 */
+	function usage() {
+		echo "Script to generate update SQL for potentially modified email texts\n"
+			. "Usage: {$this->scriptName} old-tag new-tag\n";
+	}
+
+	/**
+	 * Fetch a particular version of a file from github.
+	 * @param $repository string ojs, pkp-lib, etc.
+	 * @param $filename string
+	 * @param $tag string
+	 * @return mixed string file contents on success, false on failure.
+	 */
+	function fetchFileVersion($repository, $filename, $tag) {
+		return(@file_get_contents('https://raw.github.com/pkp/' . urlencode($repository) . '/' . urlencode($tag) . '/' . $filename));
+	}
+
+	/**
+	 * Parse into structures the XML contents of an email data file.
+	 * @param $contents string
+	 * @return array
+	 */
+	function parseEmails($contents) {
+		$parser = new XMLParser();
+		$result = $parser->parseTextStruct($contents, array('email_text', 'subject', 'body'));
+		$parser->destroy();
+		return $result;
+	}
+
+	/**
+	 * Execute the command
+	 */
+	function execute() {
+		$stderr = fopen('php://stdout', 'w');
+		$locales = AppLocale::getAllLocales();
+		$dbConn = DBConnection::getConn();
+		foreach ($locales as $locale => $localeName) {
+			fprintf($stderr, "Checking $localeName...\n");
+
+			$oldTemplatesText = $this->fetchFileVersion('ojs', "locale/$locale/emailTemplates.xml", $this->oldTag);
+			$newTemplatesText = $this->fetchFileVersion('ojs', "locale/$locale/emailTemplates.xml", $this->newTag);
+			if ($oldTemplatesText === false || $newTemplatesText === false) {
+				fprintf($stderr, "Skipping $localeName; could not fetch.\n");
+				continue;
+			}
+
+			$oldEmails = $this->parseEmails($oldTemplatesText);
+			$newEmails = $this->parseEmails($newTemplatesText);
+
+			foreach ($oldEmails['email_text'] as $oi => $junk) {
+				$key = $junk['attributes']['key'];
+
+				foreach ($newEmails['email_text'] as $ni => $junk) {
+					if ($key == $junk['attributes']['key']) break;
+				}
+
+				if ($oldEmails['subject'][$oi]['value'] != $newEmails['subject'][$ni]['value']) {
+					echo "UPDATE email_templates_default_data SET subject='" . $dbConn->escape($newEmails['subject'][$ni]['value']) . "' WHERE key='" . $dbConn->escape($key) . "' AND locale='" . $dbConn->escape($locale) . "' AND subject='" . $dbConn->escape($oldEmails['subject'][$oi]['value']) . "';\n";
+				}
+				if ($oldEmails['body'][$oi]['value'] != $newEmails['body'][$ni]['value']) {
+					echo "UPDATE email_templates_default_data SET body='" . $dbConn->escape($newEmails['body'][$ni]['value']) . "' WHERE key='" . $dbConn->escape($key) . "' AND locale='" . $dbConn->escape($locale) . "' AND body='" . $dbConn->escape($oldEmails['body'][$oi]['value']) . "';\n";
+				}
+			}
+		}
+		fclose($stderr);
+	}
+}
+
+$tool = new genEmailUpdates(isset($argv) ? $argv : array());
+$tool->execute();
+
+?>