CLDR Survey Tool

For general information, see the main README.md.

The cldr-apps subproject builds cldr-apps.war which contains the Survey Tool packaged for deployment. The Survey Tool is used to collect and confirm translations for CLDR.

DB setup

• Setup MySQL or MariaDB
• Create a database (schema), named cldrdb with codepage latin1 and collation latin1_bin (Yes, ironic)

CREATE SCHEMA `cldrdb` DEFAULT CHARACTER SET latin1 COLLATE latin1_bin ;

• Create a user surveytool

create user 'surveytool'@'localhost' IDENTIFIED BY 'your_strong_password';

• Grant the user surveytool “all” privileges

GRANT ALL PRIVILEGES ON cldrdb.* TO 'surveytool'@'localhost';

Building and Running the Survey Tool

Please use the parent CLDR/tools/pom.xml with maven to build and run.

• Copy src/main/liberty/config/server.env.sample to src/main/liberty/config/server.env
• Edit that server.env file to contain the MySQL credentials for the ST database (from above).

MYSQL_USER=surveytool
MYSQL_PASSWORD=your_strong_password
MYSQL_DB=cldrdb

• Use mvn --file=tools/pom.xml -DskipTests=true -pl cldr-apps liberty:dev to run a development web server, listening on port 9080. Hit control-C to cancel the server.

• Navigate to http://localhost:9080/cldr-apps to view the app

• See Configuration below. You will need to restart the server after edit.

See https://cldr.unicode.org/development/running-survey-tool for out of date information about the Survey Tool.

Using Logging

This is interim guidance, to be expanded upon as part of CLDR-8581

Getting a logger

Example:

class MyClass {
    static final java.util.logging.Logger logger = SurveyLog.forClass(MyClass.class);
    // …
    MyClass() {
        logger.finer("A finer point.");  // see java.util.logging.Logger docs
        logger.info("Something informative!");
        logger.warning("Something bad happened!");
    }
}

Configuring log

In bootstrap.properties or other mechanism for setting system properties, set the following to bump the log level:

com.ibm.ws.logging.trace.specification=org.unicode.cldr.web.MyClass.level=finest

You can also set in the server.xml:

<logging traceSpecification="org.unicode.cldr.web.MyClass.level=finest"/>

See https://openliberty.io/docs/21.0.0.4/log-trace-configuration.html

Testing SMTP

I use mailhog. From docker:

docker run --rm -p 8025:8025 -p 1025:1025 mailhog/mailhog

Then browse to http://localhost:8025 to watch mail flow in.

Then, setup SurveyTool with these cldr.properties (see Configuration)

CLDR_SENDMAIL=true
mail.host=127.0.0.1
mail.smtp.port=1025

## if needed
## etc see
#CLDR_SMTP_USER=authuser
#CLDR_SMTP_PASSWORD=authpassword
#mail.smtp.auth=true
#mail.smtp.starttls.enable=true
# see <https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html>

## other properties
## how long after ST startup before we start trying to send out mail
#CLDR_MAIL_DELAY_FIRST=55
## how many seconds to wait between each "batch"
#CLDR_MAIL_DELAY_EACH=15
## How many mails to send in each "batch"
#CLDR_MAIL_BATCHSIZE=0
## How long to wait between each mail in the batch.
CLDR_MAIL_DELAY_BATCH_ITEM=0

Configuration

SurveyTool is configured with a cldr.properties file which is created on first startup. It must be edited before SurveyTool can start working, to remove the CLDR_MAINTENANCE=true line.

You will also likely want to change the CLDR_DIR property in that file to point to your CLDR root, otherwise a new CLDR root will be checked out.

Search for this file in your Java workspace after launching - it may be in a random place. See Advanced Configuration below for how to move this directory. On one system the cldr directory was in tools/cldr-apps/target/liberty/wlp/usr/servers/cldr/cldr. On the production and staging servers, the location is /srv/st/config

Advanced Configuration

• There is the file tools/cldr-apps/src/main/liberty/config/jvm.options which supplies the default memory settings for SurveyTool, this file is checked in.

• The 'CLDR Home' directory as mentioned above is normally in a random location determined by the server. To fix its location, create a file tools/cldr-apps/src/main/liberty/config/bootstrap.properties with the following:

org.unicode.cldr.util.CLDRConfigImpl.cldrHome=/Users/srl295/src/cldr-st/config

You will also want to make sure this directory exists and is writeable. You can move the existing cldr.properties and other files to that directory.

Licenses

See the main README.md.

Copyright

Copyright © 2004-2024 Unicode, Inc. Unicode and the Unicode Logo are registered trademarks of Unicode, Inc. in the United States and other countries.