translation extraction does not contain all strings

[Guite]

Q	A
Zikula Version	1.4.4-git
PHP Version	7.0.8

Expected behavior

All strings should be contained in the translation catalog.

Actual behavior

While most strings are recognised, some are not. For example in a form type class, label texts are included, but help texts are not. See this screenshot from the Legal module:

Steps to reproduce

1. Install the Legal module
2. Open a console in the Zikula root folder
3. Execute php app/console translation:extract en --bundle=ZikulaLegalModule --output-format=pot
4. Check if the resulting POT file is larger than the one which is currently in Git.

[craigh]

I suspect the extractor is the problem.

[craigh]

@Guite can you please post the file(s) that you have and also tell me where you located them in order for them to work as they do in the screen shot? (refs #3132)

[Guite]

@craigh see here: https://github.com/zikula-modules/Legal/tree/master/Resources/translations

[craigh]

please explain the workflow which produced these files.

Also - if you could find an example of a string that is NOT translated and provide the location/context of that compared to strings that ARE being translated, I think that would help.

I am working on some tests for the extractor which will help this I hope.

[Guite]

please explain the workflow which produced these files.

I followed zikula-modules/Pages@b9a5bcb...89ccb5c

if you could find an example of a string that is NOT translated

This works: https://github.com/zikula-modules/Legal/blob/master/Form/Type/ConfigType.php#L82
But this not: https://github.com/zikula-modules/Legal/blob/master/Form/Type/ConfigType.php#L90
(see screenshot above)

[craigh]

This works for me if I do

php app/console translation:extract en --bundle=ZikulaLegalModule --output-format=po

it produces translations/zikula.en.po (note the domain)

but if I do

php app/console translation:extract en --bundle=ZikulaLegalModule --output-format=po --domain=zikulalegalmodule

it produces translations/zikulalegalmodule.en.po and that catalogue doesn't contain all the strings...

so not sure how to proceed here.

[craigh]

ok - I did this:

php app/console translation:extract en --bundle=ZikulaLegalModule --output-format=pot --domain=zikulalegalmodule (note I changed from .po to .pot)

A pot file includes comments to indicate where the original string is located.

This confirms that when specifying the domain that ONLY the twig files are extracted. Hence the missing strings.

then I did php app/console translation:extract en --bundle=ZikulaLegalModule --output-format=pot and this contains all the strings.

So this issue is that when specifying the domain, it doesn't extract strings from the php files. I'm not certain why this is for now.

[cmfcmf]

Can you give me an example line which is not extracted when a domain is used?

[craigh]

Can you give me an example line which is not extracted when a domain is used?

ALL strings from php files in the requested bundle.

e.g. https://github.com/zikula-modules/Legal/blob/master/Form/Type/ConfigType.php#L82

This could be different than the behavior a couple days ago (from the OP) because I just changed some of this in my recent review of translations.

[cmfcmf]

e.g. https://github.com/zikula-modules/Legal/blob/master/Form/Type/ConfigType.php#L82

It is pretty clear to me why this string is not extracted. How shall the PHP Parser, which is used to extract the strings, know that the string is of the zikulalegalmodle domain? It can't. Solution would be to use

$this->translator->trans('fosdf', [], 'zikulalegalmodule')

consistently.

Another solution would be to try to tell the extractor that the default domain inside a module folder should be the module name. No idea how this could be done right now.

[craigh]

Another solution would be to try to tell the extractor that the default domain inside a module folder should be the module name. No idea how this could be done right now.

this is done in the twig extractor:

core/src/lib/Zikula/Bundle/CoreBundle/Translation/ZikulaTwigFileExtractor.php

Lines 73 to 91 in 0d3a183

	// obtain translation domain from composer file
	$composerPath = str_replace($this->file->getRelativePathname(), '', $this->file->getPathname());
	if (isset(self::$domainCache[$composerPath])) {
	$domain = self::$domainCache[$composerPath];
	} else {
	$scanner = new Scanner();
	$scanner->scan([$composerPath], 1);
	$metaData = $scanner->getModulesMetaData(true);
	$domains = array_keys($metaData);
	if (isset($domains[0])) {
	$domain = strtolower($domains[0]);
	// cache result of file lookup
	self::$domainCache[$composerPath] = $domain;
	} else {
	$domain = 'zikula';
	}
	}
	$domainNode = array_search($name, $this->methodNames);
	$domain = $args->hasNode($domainNode) ? $args->getNode($domainNode)->getAttribute('value') : $domain;

[craigh]

in the php file extractor, the namespace of the file is (supposed to be) used to determine the translation domain:

core/src/lib/Zikula/Bundle/CoreBundle/Translation/ZikulaPhpFileExtractor.php

Lines 116 to 135 in 0d3a183

	if ($node instanceof \PHPParser_Node_Stmt_Namespace) {
	if (isset($node->name)) {
	$bundle = array_key_exists($node->name->toString(), $this->bundles) && $this->kernel->isBundle($this->bundles[$node->name->toString()]) ? $this->kernel->getBundle($this->bundles[$node->name->toString()]) : null;
	if (isset($bundle) && $bundle instanceof AbstractBundle) {
	$this->domain = $bundle->getTranslationDomain();
	} elseif (array_key_exists($node->name->toString(), $this->bundles)) {
	$this->domain = strtolower($this->bundles[$node->name->toString()]);
	} else {
	$this->domain = 'zikula';
	}
	return;
	} else {
	foreach ($node->stmts as $node) {
	$this->enterNode($node);
	}
	return;
	}
	}

[craigh]

quite sure I've fixed this, but can only test with core stuff atm. please test with legal and other bundle-type modules (@cmfcmf MediaModule)

[cmfcmf]

The MediaModule can't really be used to test this, because it is (almost)
consistently using 'cmfcmfmediamodule' as third domain parameter.

Craig Heydenburg [email protected] schrieb am Di., 15. Nov. 2016,
01:48:

Closed #3117 #3117 via #3184
#3184.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#3117 (comment), or mute the
thread
https://github.com/notifications/unsubscribe-auth/ACC7RKt0vMKJ7zJ5_kbyLVwWOjn6lPcWks5q-QFogaJpZM4KdTOd
.

[craigh]

because it is (almost) consistently using 'cmfcmfmediamodule' as third domain parameter.

a quick look at some of the php and twig files indicates otherwise.

[rallek]

I am not shure if this is fixed already. I have to do further analysis. But not this week.