Attachment #3344 for bug #6225

View | Details | Raw Unified | Return to bug 6225
Collapse All | Expand All

(-)a/classes/install/Install.inc.php (+13 lines)

Lines 65-70 class Install extends PKPInstall {	Link Here

			$this->executeSQL(sprintf('INSERT INTO users (user_id, username, first_name, last_name, password, email, date_registered, date_last_login) VALUES (%d, \'%s\', \'%s\', \'%s\', \'%s\', \'%s\', \'%s\', \'%s\')', 1, $this->getParam('adminUsername'), $this->getParam('adminUsername'), $this->getParam('adminUsername'), Validation::encryptCredentials($this->getParam('adminUsername'), $this->getParam('adminPassword'), $this->getParam('encryption')), $this->getParam('adminEmail'), Core::getCurrentDate(), Core::getCurrentDate()));

			$this->executeSQL(sprintf('INSERT INTO users (user_id, username, first_name, last_name, password, email, date_registered, date_last_login) VALUES (%d, \'%s\', \'%s\', \'%s\', \'%s\', \'%s\', \'%s\', \'%s\')', 1, $this->getParam('adminUsername'), $this->getParam('adminUsername'), $this->getParam('adminUsername'), Validation::encryptCredentials($this->getParam('adminUsername'), $this->getParam('adminPassword'), $this->getParam('encryption')), $this->getParam('adminEmail'), Core::getCurrentDate(), Core::getCurrentDate()));

			$this->executeSQL(sprintf('INSERT INTO roles (user_id, role_id) VALUES (%d, %d)', 0, 1, ROLE_ID_SITE_ADMIN));

			$this->executeSQL(sprintf('INSERT INTO roles (user_id, role_id) VALUES (%d, %d)', 0, 1, ROLE_ID_SITE_ADMIN));

			// Install email template list and data for each locale

			$emailTemplateDao =& DAORegistry::getDAO('EmailTemplateDAO');

			$this->executeSQL($emailTemplateDao->installEmailTemplates($emailTemplateDao->getMainEmailTemplatesFilename(), true));

			foreach ($this->installedLocales as $locale) {

				$this->executeSQL($emailTemplateDao->installEmailTemplateData($emailTemplateDao->getMainEmailTemplateDataFilename($locale), true));

		} else {

		} else {

			// Add initial site data

			// Add initial site data

			$locale = $this->getParam('locale');

			$locale = $this->getParam('locale');

Lines 80-85 class Install extends PKPInstall {	Link Here

				return false;

				return false;

			// Install email template list and data for each locale

			$emailTemplateDao =& DAORegistry::getDAO('EmailTemplateDAO');

			$emailTemplateDao->installEmailTemplates($emailTemplateDao->getMainEmailTemplatesFilename());

			foreach ($this->installedLocales as $locale) {

				$emailTemplateDao->installEmailTemplateData($emailTemplateDao->getMainEmailTemplateDataFilename($locale));

			// Install site settings

			// Install site settings

			$siteSettingsDao =& DAORegistry::getDAO('SiteSettingsDAO');

			$siteSettingsDao =& DAORegistry::getDAO('SiteSettingsDAO');

			$siteSettingsDao->installSettings('registry/siteSettings.xml', array(

			$siteSettingsDao->installSettings('registry/siteSettings.xml', array(




<?php

/**
 * @file EmailTemplate.inc.php
 *
 * Copyright (c) 2005-2010 Alec Smecher and John Willinsky
 * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
 *
 * BaseEmailTemplate, EmailTemplate classes implemented here; these
 * describe basic email template properties.
 *
 * @package mail
 *
 * $Id$
 */

/**
 * Email template base class.
 */
class BaseEmailTemplate extends DataObject {

	/**
	 * Constructor.
	 */
	function BaseEmailTemplate() {
		parent::DataObject();
	}

	//
	// Get/set methods
	//

	/**
	 * Get ID of email template.
	 * @return int
	 */
	function getEmailId() {
		return $this->getData('emailId');
	}

	/**
	 * Set ID of email template.
	 * @param $emailId int
	 */
	function setEmailId($emailId) {
		return $this->setData('emailId', $emailId);
	}

	/**
	 * Get key of email template.
	 * @return string
	 */
	function getEmailKey() {
		return $this->getData('emailKey');
	}

	/**
	 * Set key of email template.
	 * @param $emailKey string
	 */
	function setEmailKey($emailKey) {
		return $this->setData('emailKey', $emailKey);
	}

	/**
	 * Get the enabled setting of email template.
	 * @return boolean
	 */
	function getEnabled() {
		return $this->getData('enabled');
	}

	/**
	 * Set the enabled setting of email template.
	 * @param $enabled boolean
	 */
	function setEnabled($enabled) {
		return $this->setData('enabled', $enabled);
	}

	/**
	 * Check if email template is allowed to be disabled.
	 * @return boolean
	 */
	function getCanDisable() {
		return $this->getData('canDisable');
	}

	/**
	 * Set whether or not email template is allowed to be disabled.
	 * @param $canDisable boolean
	 */
	function setCanDisable($canDisable) {
		return $this->setData('canDisable', $canDisable);
	}

}


/**
 * Email template with data for all supported locales.
 */
class EmailTemplate extends BaseEmailTemplate {

	/** @var $localeData array of localized email template data */
	var $localeData;

	/**
	 * Constructor.
	 */
	function EmailTemplate() {
		parent::BaseEmailTemplate();
		$this->localeData = array();
	}

	/**
	 * Add a new locale to store data for.
	 * @param $locale string
	 */
	function addLocale($locale) {
		$this->localeData[$locale] = array();
	}

	/**
	 * Get set of supported locales for this template.
	 * @return array
	 */
	function getLocales() {
		return array_keys($this->localeData);
	}

	//
	// Get/set methods
	//

	/**
	 * Get description of email template.
	 * @param $locale string
	 * @return string
	 */
	function getDescription($locale) {
		return isset($this->localeData[$locale]['description']) ? $this->localeData[$locale]['description'] : '';
	}

	/**
	 * Set description of email template.
	 * @param $locale string
	 * @param $description string
	 */
	function setDescription($locale, $description) {
		$this->localeData[$locale]['description'] = $description;
	}

	/**
	 * Get subject of email template.
	 * @param $locale string
	 * @return string
	 */
	function getSubject($locale = null) {
		if ($locale === null) $locale = Locale::getLocale();
		return isset($this->localeData[$locale]['subject']) ? $this->localeData[$locale]['subject'] : '';
	}

	/**
	 * Set subject of email template.
	 * @param $locale string
	 * @param $subject string
	 */
	function setSubject($locale, $subject) {
		$this->localeData[$locale]['subject'] = $subject;
	}

	/**
	 * Get body of email template.
	 * @param $locale string
	 * @return string
	 */
	function getBody($locale = null) {
		if ($locale === null) $locale = Locale::getLocale();
		return isset($this->localeData[$locale]['body']) ? $this->localeData[$locale]['body'] : '';
	}

	/**
	 * Set body of email template.
	 * @param $locale string
	 * @param $body string
	 */
	function setBody($locale, $body) {
		$this->localeData[$locale]['body'] = $body;
	}
}

?>




<?php

/**
 * @file classes/mail/EmailTemplateDAO.inc.php
 *
 * Copyright (c) 2005-2010 Alec Smecher and John Willinsky
 * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
 *
 * @package mail
 * @class EmailTemplateDAO
 * @ingroup mail
 * @see EmailTemplate
 *
 * @brief Operations for retrieving and modifying Email Template objects.
 * Operations for retrieving and modifying Email Template objects.
 *
 * $Id$
 */

// $Id$

class EmailTemplateDAO extends DAO {

import('lib.pkp.classes.mail.PKPEmailTemplateDAO');
import('lib.pkp.classes.mail.EmailTemplate');
	 */
	function EmailTemplateDAO() {
		parent::DAO();
	}

class EmailTemplateDAO extends PKPEmailTemplateDAO {
	/**
	 * Retrieve a base email template by key.
	 * @param $emailKey string
	 * @return BaseEmailTemplate
	 */
	function &getBaseEmailTemplate($emailKey) {
		$returner =& parent::getBaseEmailTemplate($emailKey, 0, 0);
			'SELECT d.email_key, d.can_edit, d.can_disable, d.enabled
			FROM email_templates AS d
			WHERE d.email_key = ?',
			$emailKey
		);

		$returner = null;
		if ($result->RecordCount() != 0) {
			$returner =& $this->_returnEmailTemplateFromRow($result->GetRowAssoc(false));
		}

		$result->Close();
		unset($result);

		return $returner;
	}

	/**
	 * Retrieve localized email template by key.
	 * @param $emailKey string
	 * @return LocaleEmailTemplate
	 */
	function &_returnEmailTemplateFromRow(&$row) {
		$emailTemplate = new EmailTemplate();
		$emailTemplate->setEmailKey($row['email_key']);
		$emailTemplate->setEnabled($row['enabled']);
		$emailTemplate->setCanDisable($row['can_disable']);

		if (!HookRegistry::call('EmailTemplateDAO::_returnEmailTemplateFromRow', array(&$emailTemplate, &$row))) {
			$result =& $this->retrieve(
				'SELECT d.locale, d.description, d.subject, d.body
				FROM email_templates_data AS d
				WHERE d.email_key = ?',
				$row['email_key']
			);

			while (!$result->EOF) {
				$dataRow =& $result->GetRowAssoc(false);
				$emailTemplate->addLocale($dataRow['locale']);
				$emailTemplate->setSubject($dataRow['locale'], $dataRow['subject']);
				$emailTemplate->setBody($dataRow['locale'], $dataRow['body']);
				$emailTemplate->setDescription($dataRow['locale'], $dataRow['description']);
				$result->MoveNext();
			}
			$result->Close();
			unset($result);
		}

		return $emailTemplate;
	}

	/**
	 * Insert a new base email template.
	 * @param $emailTemplate BaseEmailTemplate
	 */	
	function insertBaseEmailTemplate(&$emailTemplate) {
		return $this->update(
			'INSERT INTO email_templates
				(email_key, enabled)
				VALUES
				(?, ?)',
			array(
				$emailTemplate->getEmailKey(),
				$emailTemplate->getEnabled() == null ? 0 : 1
			)
		);
		$emailTemplate->setEmailId($this->getInsertEmailId());
		return $emailTemplate->getEmailId();
	}

	/**
	 * Update an existing base email template.
	 * @param $emailTemplate BaseEmailTemplate
	 */
	function &getLocaleEmailTemplate($emailKey) {
		$returner =& parent::getLocaleEmailTemplate($emailKey, 0, 0);
		return $returner;
				SET	enabled = ?
				WHERE email_key = ?',
			array(
				$emailTemplate->getEnabled() == null ? 0 : 1,
				$emailTemplate->getEmailKey()
			)
		);
	}

	/**
	 * Insert a new localized email template.
	 * @param $emailTemplate EmailTemplate
	 */	
	function insertEmailTemplate(&$emailTemplate) {
		$this->insertBaseEmailTemplate($emailTemplate);
		return $this->updateEmailTemplateData($emailTemplate);
	}

	/**
	 * Retrieve an email template by key.
	 * @param $emailKey string
	 * @param $locale string
	 * @return EmailTemplate
	 */
	function &getEmailTemplate($emailKey, $locale) {
		$returner =& parent::getEmailTemplate($emailKey, $locale, 0, 0);
		return $returner;
				'SELECT COUNT(*) FROM email_templates_data
				WHERE email_key = ? AND locale = ?',
				array($emailTemplate->getEmailKey(), $locale)
			);

			if ($result->fields[0] == 0) {
				$this->update(
					'INSERT INTO email_templates_data
					(email_key, locale, subject, body)
					VALUES
					(?, ?, ?, ?)',
					array($emailTemplate->getEmailKey(), $locale, $emailTemplate->getSubject($locale), $emailTemplate->getBody($locale))
				);

			} else {
				$this->update(
					'UPDATE email_templates_data
					SET subject = ?,
						body = ?
					WHERE email_key = ? AND locale = ?',
					array($emailTemplate->getSubject($locale), $emailTemplate->getBody($locale), $emailTemplate->getEmailKey(), $locale)
				);
			}

			$result->Close();
			unset($result);
		}
	}

	/**

	 * @param $emailKey string
	 */
	function deleteEmailTemplateByKey($emailKey) {
		return parent::deleteEmailTemplateByKey($emailKey, 0, 0);
			'DELETE FROM email_templates WHERE email_key = ?',
			$emailKey
		);
	}

	/**
	 * Retrieve all email templates.
	 * @param $locale string
	 * @param $rangeInfo object optional
	 * @return array Email templates
	 */
	function &getEmailTemplates($locale, $rangeInfo = null) {
		$returner =& parent::getEmailTemplates($locale, 0, 0, $rangeInfo);
		return $returner;
	}

	/**
	 * Check if a template exists with the given email key.
	 * @param $emailKey string
	 * @return boolean
	 */
	function templateExistsByKey($emailKey) {
		return parent::templateExistsByKey($emailKey, 0, 0);
			'DELETE FROM email_templates_data WHERE locale = ?', $locale
		);
	}

	/**
	 * Check if a custom template exists with the given email key for a journal.
	 * @param $emailKey string
	 * @return boolean
	 */
	function customTemplateExistsByKey($emailKey) {
		return parent::customTemplateExistsByKey($emailKey, 0, 0);
			'DELETE FROM email_templates_default_data WHERE locale = ?', $locale
		);*/ // Not used in Harvester, but called from PKP. FIXME
	}
}





<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE data SYSTEM "../../../../../lib/pkp/dtd/xmlData.dtd">

<!--
  * email_templates_data.xml
  *
  * Copyright (c) 2005-2010 Alec Smecher and John Willinsky
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * Email templates data XML file (English).
  *
  * $Id$
  -->

<data>
	<table name="email_templates_data">
		<field_default name="locale">en_US</field_default>

		<!--
		  *
		  * General
		  *
		  -->
		<row>
			<field name="email_key">PASSWORD_RESET_CONFIRM</field>
			<field name="subject">Password Reset Confirmation</field>
			<field name="body">We have received a request to reset your password for the {$siteTitle} web site.

If you did not make this request, please ignore this email and your password will not be changed. If you wish to reset your password, click on the below URL.

Reset my password: {$url}

{$principalContactSignature}</field>
			<field name="description">This email is sent to a registered user when they indicate that they have forgotten their password or are unable to login. It provides a URL they can follow to reset their password.</field>
		</row>
		<row>
			<field name="email_key">PASSWORD_RESET</field>
			<field name="subject">Password Reset</field>
			<field name="body">Your password has been successfully reset for use with the {$siteTitle} web site. Please retain this username and password, as it is necessary for all work with the site.

Your username: {$username}
Your new password: {$password}

{$principalContactSignature}</field>
			<field name="description">This email is sent to a registered user when they have successfully reset their password following the process described in the PASSWORD_RESET_CONFIRM email.</field>
		</row>
		<row>
			<field name="email_key">USER_REGISTER</field>
			<field name="subject">Journal Registration</field>
			<field name="body">{$userFullName}

You have now been registered as a user. We have included your username and password in this email, which are needed for all work with this website. At any point, you can ask to be removed from the list of users by contacting me.

Username: {$username}
Password: {$password}

Thank you,
{$principalContactSignature}</field>
			<field name="description">This email is sent to a newly registered user to welcome them to the system and provide them with a record of their username and password.</field>
		</row>
		<row>
			<field name="email_key">USER_VALIDATE</field>
			<field name="subject">Validate Your Account</field>
			<field name="body">{$userFullName}

You have created an account, but before you can start using it, you need to validate your email account. To do this, simply follow the link below:

{$activateUrl}

Thank you,
{$principalContactSignature}</field>
			<field name="description">This email is sent to a newly registered user to welcome them to the system and provide them with a record of their username and password.</field>
		</row>
		<row>
			<field name="email_key">NEW_ARCHIVE_NOTIFY</field>
			<field name="subject">Archive Added: {$archiveTitle}</field>
			<field name="body">A new archive, "{$archiveTitle}", has been submitted for addition to {$siteTitle}. To index this archive, log in at {$loginUrl} or use the command-line harvester tool.</field>
			<field name="description">This email is sent to the site administrator to notify them about a new archive submission that needs to be indexed.</field>
		</row>
	</table>
</data>




<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE data SYSTEM "../../../../../lib/pkp/dtd/xmlData.dtd">

<!--
  * email_templates_data.xml
  *
  * Copyright (c) 2005-2010 Alec Smecher and John Willinsky
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * Email templates data XML file (English).
  *
  * $Id$
  -->

<data>
	<table name="email_templates_data">
		<field_default name="locale">en_US</field_default>

		<!--
		  *
		  * General
		  *
		  -->
		<row>
			<field name="email_key">NEW_ARCHIVE_NOTIFY</field>
			<field name="subject">Archive Added: {$archiveTitle}</field>
			<field name="body">A new archive, "{$archiveTitle}", has been submitted for addition to {$siteTitle}. To index this archive, log in at {$loginUrl} or use the command-line harvester tool.</field>
			<field name="description">This email is sent to the site administrator to notify them about a new archive submission that needs to be indexed.</field>
		</row>
	</table>
</data>




	
	<!--
	  *
	  * TABLE email_templates
	  *
	  -->
	<table name="email_templates">
		<field name="email_id" type="I4">
			<KEY/>
			<AUTOINCREMENT/>
		</field>
		<field name="email_key" type="C2" size="30">
			<NOTNULL/>
			<descr>Unique identifier for this email.</descr>
		</field>
		<field name="enabled" type="I1">
			<NOTNULL/>
			<DEFAULT VALUE="1"/>
		</field>
		<field name="can_disable" type="I1">
			<NOTNULL/>
			<DEFAULT VALUE="1"/>
		</field>
		<field name="can_edit" type="I1">
			<NOTNULL/>
			<DEFAULT VALUE="1"/>
		</field>
		<descr>Email templates.</descr>
		<index name="email_templates_default_email_key">
			<col>email_key</col>
			<UNIQUE/>
		</index>
	</table>
	
	<!--
	  *
	  * TABLE email_templates_data
	  *
	  -->
	<table name="email_templates_data">
		<field name="email_key" type="C2" size="30">
			<KEY/>
			<descr>Unique identifier for this email.</descr>
		</field>
		<field name="locale" type="C2" size="5">
			<KEY/>
			<DEFAULT VALUE="en_US"/>
		</field>
		<field name="subject" type="C2" size="120">
			<NOTNULL/>
		</field>
		<field name="body" type="X"/>
		<field name="description" type="X"/>
		<descr>Default data for email templates.</descr>
	</table>
	
	<!--
	  *
	  * TABLE rt_versions
	  *
	 -->

(-)a/dbscripts/xml/install.xml (-2 lines)

Lines 23-30	Link Here

	<schema file="dbscripts/xml/harvester2_schema.xml" />

	<schema file="dbscripts/xml/harvester2_schema.xml" />

	<!-- Other install tasks -->

	<!-- Other install tasks -->

	<data file="dbscripts/xml/data/email_templates.xml" />

	<data file="dbscripts/xml/data/locale/{$installedLocale}/email_templates_data.xml" />

	<code function="createData" />

	<code function="createData" />

	<code function="createConfig" />

	<code function="createConfig" />

</install>

</install>




<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE email_texts SYSTEM "../../lib/pkp/dtd/emailTemplateData.dtd">
<!--
  * locale/en_US/emailTemplateData.xml
  *
  * Copyright (c) 2005-2010 Alec Smecher and John Willinsky
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * Localized email templates XML file.
  *
  -->
<email_texts locale="en_US">
	<email_text key="PASSWORD_RESET_CONFIRM">
		<subject>Password Reset Confirmation</subject>
		<body>We have received a request to reset your password for the {$siteTitle} web site.

If you did not make this request, please ignore this email and your password will not be changed. If you wish to reset your password, click on the below URL.

Reset my password: {$url}

{$principalContactSignature}</body>
		<description>This email is sent to a registered user when they indicate that they have forgotten their password or are unable to login. It provides a URL they can follow to reset their password.</description>
	</email_text>
	<email_text key="PASSWORD_RESET">
		<subject>Password Reset</subject>
		<body>Your password has been successfully reset for use with the {$siteTitle} web site. Please retain this username and password, as it is necessary for all work with the site.

Your username: {$username}
Your new password: {$password}

{$principalContactSignature}</body>
		<description>This email is sent to a registered user when they have successfully reset their password following the process described in the PASSWORD_RESET_CONFIRM email.</description>
	</email_text>
	<email_text key="USER_REGISTER">
		<subject>Journal Registration</subject>
		<body>{$userFullName}

You have now been registered as a user. We have included your username and password in this email, which are needed for all work with this website. At any point, you can ask to be removed from the list of users by contacting me.

Username: {$username}
Password: {$password}

Thank you,
{$principalContactSignature}</body>
		<description>This email is sent to a newly registered user to welcome them to the system and provide them with a record of their username and password.</description>
	</email_text>
	<email_text key="USER_VALIDATE">
		<subject>Validate Your Account</subject>
		<body>{$userFullName}

You have created an account, but before you can start using it, you need to validate your email account. To do this, simply follow the link below:

{$activateUrl}

Thank you,
{$principalContactSignature}</body>
		<description>This email is sent to a newly registered user to welcome them to the system and provide them with a record of their username and password.</description>
	</email_text>
	<email_text key="NEW_ARCHIVE_NOTIFY">
		<subject>Archive Added: {$archiveTitle}</subject>
		<body>A new archive, "{$archiveTitle}", has been submitted for addition to {$siteTitle}. To index this archive, log in at {$loginUrl} or use the command-line harvester tool.</body>
		<description>This email is sent to the site administrator to notify them about a new archive submission that needs to be indexed.</description>
	</email_text>
</email_texts>




<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE emails SYSTEM "../../lib/pkp/dtd/emailTemplates.dtd">
<!--
  * registry/emailTemplates.xml
  *
  * Copyright (c) 2005-2010 Alec Smecher and John Willinsky
  * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
  *
  * Email templates XML file.
  *
  -->
<emails>
	<email key="PASSWORD_RESET_CONFIRM" can_edit="1" can_disable="0"/>
	<email key="PASSWORD_RESET" can_edit="1" can_disable="0"/>
	<email key="USER_REGISTER" can_edit="1" can_disable="0"/>
	<email key="USER_VALIDATE" can_edit="1" can_disable="0"/>
	<email key="NEW_ARCHIVE_NOTIFY" can_edit="1" can_disable="1"/>
</emails>




<?php

/**
 * @file tools/localeCheck.php
 *
 * Copyright (c) 2005-2010 Alec Smecher and John Willinsky
 * Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
 *
 * @class localeCheck
 * @ingroup tools
 *
 * @brief CLI tool to check the various locales for consistency.
 *
 */

// $Id$


require(dirname(__FILE__) . '/bootstrap.inc.php');

define('MASTER_LOCALE', 'en_US');

define('LOCALE_ERROR_MISSING_KEY',		0x0000001);
define('LOCALE_ERROR_EXTRA_KEY',		0x0000002);
define('LOCALE_ERROR_SUSPICIOUS_LENGTH',	0x0000003);
define('LOCALE_ERROR_DIFFERING_PARAMS',		0x0000004);

define('EMAIL_ERROR_MISSING_EMAIL',		0x0000005);
define('EMAIL_ERROR_EXTRA_EMAIL',		0x0000006);
define('EMAIL_ERROR_DIFFERING_PARAMS',		0x0000007);

class localeCheck extends CommandLineTool {
	/** @var $locales List of locales to check */
	var $locales;

	function localeCheck($args) {
		parent::CommandLineTool($args);
		array_shift($args); // Knock the tool name off the list
		$this->locales = $args;
	}

	/**
	 * Print command usage information.
	 */
	function usage() {
		echo "Script to test locales for consistency\n"
			. "Usage: {$this->scriptName} [localeName (optional)] ...\n";
	}

	/**
	 * Test locales.
	 */
	function execute() {
		// Flush the file cache just to be certain we're using
		// the most recent stuff
		import('lib.pkp.classes.cache.CacheManager');
		$cacheManager =& CacheManager::getManager();
		$cacheManager->flush('locale');

		// Load plugins so that their locale data is included too
		$plugins = array();
		foreach (PluginRegistry::getCategories() as $category) {
			echo "Loading plugin category \"$category\"...\n";
			$morePlugins = PluginRegistry::loadCategory($category);
			if (is_array($morePlugins)) $plugins += $morePlugins;
		}

		foreach (Locale::getAllLocales() as $locale => $name) {
			if (!empty($this->locales) && !in_array($locale, $this->locales)) continue;
			if ($locale != MASTER_LOCALE) {
				echo "Testing locale \"$name\" ($locale) against reference locale " . MASTER_LOCALE . ".\n";
				$this->testLocale($locale, MASTER_LOCALE, $plugins);
				$this->testEmails($locale, MASTER_LOCALE);
			}
		}
	}

	function testEmails($locale, $referenceLocale) {
		import('lib.pkp.classes.install.Installer'); // Bring in data dir

		$errors = array(
		);

		$xmlParser = new XMLParser();
		$referenceEmails =& $xmlParser->parse(
			INSTALLER_DATA_DIR . "/data/locale/$referenceLocale/email_templates_data.xml"
		);
		$emails =& $xmlParser->parse(
			INSTALLER_DATA_DIR . "/data/locale/$locale/email_templates_data.xml"
		);
		$emailsTable =& $emails->getChildByName('table');
		$referenceEmailsTable =& $referenceEmails->getChildByName('table');
		$matchedReferenceEmails = array();

		// Pass 1: For all translated emails, check that they match
		// against reference translations.
		for ($emailIndex = 0; ($email =& $emailsTable->getChildByName('row', $emailIndex)) !== null; $emailIndex++) {
			// Extract the fields from the email to be tested.
			$fields = $this->extractFields($email);

			// Locate the reference email and extract its fields.
			for ($referenceEmailIndex = 0; ($referenceEmail =& $referenceEmailsTable->getChildByName('row', $referenceEmailIndex)) !== null; $referenceEmailIndex++) {
				$referenceFields = $this->extractFields($referenceEmail);
				if ($referenceFields['email_key'] == $fields['email_key']) break;
			}

			// Check if a matching reference email was found.
			if (!isset($referenceEmail) || $referenceEmail === null) {
				$errors[EMAIL_ERROR_EXTRA_EMAIL][] = array(
					'key' => $fields['email_key']
				);
				continue;
			}

			// We've successfully found a matching reference email.
			// Compare it against the translation.
			$bodyParams = $this->getParameterNames($fields['body']);
			$referenceBodyParams = $this->getParameterNames($referenceFields['body']);
			if ($bodyParams !== $referenceBodyParams) {
				$errors[EMAIL_ERROR_DIFFERING_PARAMS][] = array(
					'key' => $fields['email_key'],
					'mismatch' => array_diff($bodyParams, $referenceBodyParams)
				);
			}

			$subjectParams = $this->getParameterNames($fields['subject']);
			$referenceSubjectParams = $this->getParameterNames($referenceFields['subject']);

			if ($subjectParams !== $referenceSubjectParams) {
				$errors[EMAIL_ERROR_DIFFERING_PARAMS][] = array(
					'key' => $fields['email_key'],
					'mismatch' => array_diff($subjectParams, $referenceSubjectParams)
				);
			}

			$matchedReferenceEmails[] = $fields['email_key'];

			unset($email);
			unset($referenceEmail);
		}

		// Pass 2: Make sure that there are no missing translations.
		for ($referenceEmailIndex = 0; ($referenceEmail =& $referenceEmailsTable->getChildByName('row', $referenceEmailIndex)) !== null; $referenceEmailIndex++) {
			// Extract the fields from the email to be tested.
			$referenceFields = $this->extractFields($referenceEmail);
			if (!in_array($referenceFields['email_key'], $matchedReferenceEmails)) {
				$errors[EMAIL_ERROR_MISSING_EMAIL][] = array(
					'key' => $referenceFields['email_key']
				);
			}
		}

		$this->displayEmailErrors($locale, $errors);
	}

	function extractFields(&$node) {
		$returner = array();
		foreach ($node->getChildren() as $field) if ($field->getName() === 'field') {
			$returner[$field->getAttribute('name')] = $field->getValue();
		}
		return $returner;
	}

	function displayEmailErrors($locale, $errors) {
		ksort($errors);
		echo "\nERROR REPORT FOR EMAILS IN \"$locale\":\n";
		echo "-----------------------------------\n";
		foreach ($errors as $type => $errorList) {
			if (!empty($errorList)) switch ($type) {
				case EMAIL_ERROR_MISSING_EMAIL:
					echo "The following messages are missing from the emails file and need translation.\n";
					foreach ($errorList as $error) echo " - " . $error['key'] . "\n";
					break;
				case EMAIL_ERROR_EXTRA_EMAIL:
					echo "\nThe following emails are not in the master translation and may be deleted:\n";
					foreach ($errorList as $error) echo " - " . $error['key'] . "\n";
					break;
				case EMAIL_ERROR_DIFFERING_PARAMS:
					echo "\nThe following emails are missing parameters or have extra parameters and need\n";
					echo "correcting against the master translation:\n";
					foreach ($errorList as $error) {
						echo " - " . $error['key'] . "\n";
						echo "   Mismatching parameter(s): " . implode(', ', $error['mismatch']) . "\n";
					}
					break;
				default: die("Unknown error type \"$type\"!\n");
			}
		}
	}

	function testLocale($locale, $referenceLocale, $plugins) {
		$errors = array(
			LOCALE_ERROR_MISSING_KEY => array(),
			LOCALE_ERROR_EXTRA_KEY => array(),
			LOCALE_ERROR_SUSPICIOUS_LENGTH => array(),
			LOCALE_ERROR_DIFFERING_PARAMS => array()
		);

		$localeCache =& Locale::_getCache($locale);
		$referenceLocaleCache =& Locale::_getCache($referenceLocale);

		$localeContents =& $localeCache->getContents();
		$referenceContents =& $referenceLocaleCache->getContents();

		// Add locale data for plugins
		foreach ($plugins as $plugin) {
			$pluginCache = $plugin->_getCache($locale);
			$referencePluginCache = $plugin->_getCache($referenceLocale);
			$localeContents += $pluginCache->getContents();
			$referenceContents += $referencePluginCache->getContents();
		}

		foreach ($referenceContents as $key => $referenceValue) {
			if (!isset($localeContents[$key])) {
				$errors[LOCALE_ERROR_MISSING_KEY][] = array(
					'key' => $key,
					'locale' => $locale
				);
				continue;
			}
			$value = $localeContents[$key];

			// Watch for suspicious lengths.
			if (!$this->checkLengths($referenceValue, $value)) {
				$errors[LOCALE_ERROR_SUSPICIOUS_LENGTH][] = array(
					'key' => $key,
					'locale' => $locale,
					'reference' => $referenceValue,
					'value' => $value
				);
			}

			$referenceParams = $this->getParameterNames($referenceValue);
			$params = $this->getParameterNames($value);
			if ($referenceParams !== $params) {
				$errors[LOCALE_ERROR_DIFFERING_PARAMS][] = array(
					'key' => $key,
					'locale' => $locale,
					'mismatch' => array_diff($referenceParams, $params)
				);
			}
			// After processing a key, remove it from the list;
			// this way, the remainder at the end of the loop
			// will be extra unnecessary keys.
			unset($localeContents[$key]);
		}

		// Leftover keys are extraneous.
		foreach ($localeContents as $key => $value) {
			$errors[LOCALE_ERROR_EXTRA_KEY][] = array(
				'key' => $key,
				'locale' => $locale
			);
		}

		$this->displayLocaleErrors($locale, $errors);
	}

	function displayLocaleErrors($locale, $errors) {
		ksort($errors);
		echo "\nERROR REPORT FOR LOCALE STRINGS IN \"$locale\":\n";
		echo "---------------------------------------\n";
		foreach ($errors as $type => $errorList) {
			if (!empty($errorList)) switch ($type) {
				case LOCALE_ERROR_MISSING_KEY:
					echo "The following keys are missing from a locale file and need to be translated.\n";
					foreach ($errorList as $error) echo " - " . $error['key'] . "\n";
					break;
				case LOCALE_ERROR_EXTRA_KEY:
					echo "\nThe following keys are not in the master translation and may be deleted:\n";
					foreach ($errorList as $error) echo " - " . $error['key'] . "\n";
					break;
				case LOCALE_ERROR_SUSPICIOUS_LENGTH:
					echo "\nThe following keys have suspicious lengths compared with the master translation\n";
					echo "and may need checking:\n";
					foreach ($errorList as $error) {
						$reference = $this->truncate($error['reference'], 65);
						$value = $this->truncate($error['value'], 65);
						echo " - " . $error['key'] . "\n";
						echo "   \"" . $reference . "\" vs.\n";
						echo "   \"" . $value . "\" ($locale)\n";
					}
					break;
				case LOCALE_ERROR_DIFFERING_PARAMS:
					echo "\nThe following keys are missing parameters or have extra parameters and need\n";
					echo "correcting against the master translation:\n";
					foreach ($errorList as $error) {
						echo " - " . $error['key'] . "\n";
						echo "   Mismatching parameter(s): " . implode(', ', $error['mismatch']) . "\n";
					}
					break;
				default: die("Unknown error type \"$type\"!\n");
			}
		}
	}

	function truncate($value, $length = 80, $ellipsis = '...') {
		if (String::strlen($value) > $length) {
			$value = String::substr($value, 0, $length - String::strlen($ellipsis));
			return $value . $ellipsis;
		}
		return $value;
	}

	function checkLengths($reference, $value) {
		$referenceLength = String::strlen($reference);
		$length = String::strlen($value);
		$lengthDifference = abs($referenceLength - $length);
		if ($referenceLength == 0) return false;
		if ($lengthDifference / $referenceLength > 1 && $lengthDifference > 10) return false;
		return true;
	}

	/**
	 * Given a locale string, get the list of parameter references of the
	 * form {$myParameterName}.
	 * @param $source string
	 * @return array
	 */
	function getParameterNames($source) {
		$matches = null;
		String::regexp_match_get('/({\$[^}]+})/' /* '/{\$[^}]+})/' */, $source, $matches);
		array_shift($matches); // Knock the top element off the array
		return $matches;
	}
}

$tool = new localeCheck(isset($argv) ? $argv : array());
$tool->execute();

?>

Return to bug 6225