Start import process when modules/themes are enabled/installed [#1338886]

I have an own module with the translation file in the module's translation folder. I install it during installation as a dependency of the install profile. l10n_update is also a dependency.

I have an install task to import the translation:

/**
 * Implement hook_install_tasks().
 */
function zenede_profile_install_tasks($install_state) {
  return array(
    'zenede_profile_install_import_translation' => array(
      'display_name' => st('Set up translations'),
      'display' => TRUE,
      'run' => INSTALL_TASK_RUN_IF_NOT_COMPLETED,
      'type' => 'batch',
    ),
  );
}

/**
 * Installation step callback.
 *
 * @param $install_state
 *   An array of information about the current installation state.
 */
function zenede_profile_install_import_translation(&$install_state) {
  // Enable installation language as default site language.
  include_once DRUPAL_ROOT . '/includes/locale.inc';
  $install_locale = $install_state['parameters']['locale'];
  locale_add_language($install_locale, NULL, NULL, NULL, '', NULL, 1, TRUE);
  // Build batch with l10n_update module.
  $history = l10n_update_get_history();
  module_load_include('check.inc', 'l10n_update');
  $available = l10n_update_available_releases();
  $updates = l10n_update_build_updates($history, $available);
  module_load_include('batch.inc', 'l10n_update');
  $updates = _l10n_update_prepare_updates($updates, NULL, array());
  $batch = l10n_update_batch_multiple($updates, LOCALE_IMPORT_KEEP);
  return $batch;
}

However, it only imports from the remote server, not from the local folders. I took a look at the code and it seems to me that this is not the intended behaviour.

Comment	File	Size	Author
#24	l10n_update-implement_hook_modules_enable-1338886-24.patch	4.23 KB	sutharsan
#15	l10n_update-implement_hook_modules_enable-1338886-15.patch	4.21 KB	sutharsan
#12	l10n_update-implement_hook_modules_enable-1338886-12.patch	4.22 KB	sutharsan
#11	l10n_update-implement_hook_modules_enable-1338886-11.patch	4.27 KB	sutharsan

Comments

Comment #1

gábor hojtsy

he/him

Hungarian

Hungary

commented 14 November 2011 at 12:24

Category:	bug	» support
Status:	Active	» Fixed

l10n_update would import .po files from one central directory, not from under a module's translation folder. The later method was deprecated by the drupal.org git deployment and is not supported in Drupal 8 anymore. Just ship those files in a central translations directory and configure the module to use that.

Comment #2

czigor commented 15 November 2011 at 07:27

Status:

Fixed

» Active

I've created a /translations directory and copied all the po files there. But how do I configure my module to search for its translation files there?

Comment #3

gábor hojtsy

he/him

Hungarian

Hungary

commented 15 November 2011 at 07:37

You can just variable_set() the translations directory in your profile. Check the l10n_update setting page for the variable name.

Comment #4

czigor commented 18 November 2011 at 15:04

Status:

Active

» Fixed

Thanks for your answers! I have managed to get it work.

I have put all my translation files in sites/all/translations. It is important that the module "mymodule" should have the
project = "mymodule"
~~version = "mymodule-7.x-1.0"~~
version = "7.x-1.0"
lines in its info file. Without these the module does not appear in the admin/config/regional/translate/update list. The po file should be "sites/all/translations/mymodule-7.x-1.0.hu.po".

I have added the following lines to my profile (these are all the variables I have found that start with l10n_update):
variable_set('l10n_update_download_store', 'sites/all/translations');
variable_set('l10n_update_check_disabled', '0');
variable_set('l10n_update_check_frequency', '0');
variable_set('l10n_update_check_mode', '3');
variable_set('l10n_update_import_mode', '1');

Comment #5

czigor commented 23 November 2011 at 09:02

Status:

Fixed

» Active

The problem with this solution is that po files don't get imported from the sites/all/translations folder on module install.

So what is the right way to do this? Are we supposed to keep the po files of the modules that are enabled from the profile in sites/all/translations and those of other modules in mymodule/translations?

Comment #7

gábor hojtsy

he/him

Hungarian

Hungary

commented 23 November 2011 at 09:14

@czigor: you should not have .po files under modules anymore, all .po files for a site should be all in one directory and identified and tied to projects by their names.

Comment #8

gábor hojtsy

he/him

Hungarian

Hungary

commented 23 November 2011 at 09:16

@czigor: if the problem is that when you enable random modules, their .po files are not imported right away, that would possible need a hook implementation in l10n_update (if its not already there) to do an import which would then look for all the localization files again with the new module list in mind.

Comment #9

czigor commented 23 November 2011 at 10:38

Category:

support

» feature

#8: Yes, that is the problem.
So this means that we should implement hook_modules_enabled in l10n_update? (According to a quick 'grep modules_enabled' it is not implemented yet.)

In this case I don't really understand why and how the translations of d.o. contrib modules are downloaded when we enable them. That is: what's the difference between enabling a contrib and a random module? Is there a list of po files in sites/all/translations/ that needs to be refreshed?

Comment #10

gábor hojtsy

he/him

Hungarian

Hungary

commented 23 November 2011 at 15:03

Title:

po files import from install profile

» Start import process when modules/themes are enabled/installed

Well, currently they are downloaded via cron or manual updates only. This looks like a very important feature request, yes. Retitling for that.

Comment #11

sutharsan commented 28 December 2011 at 12:52

Status:

Active

» Needs review

Status	File	Size
new	l10n_update-implement_hook_modules_enable-1338886-11.patch	4.27 KB

Translations are downloaded using an additional submit handler on the Modules page. This patch changes that to an implementation of hook_modules_enabled(). Have a try with this.

Comment #12

sutharsan commented 8 January 2012 at 21:55

Status	File	Size
new	l10n_update-implement_hook_modules_enable-1338886-12.patch	4.22 KB

Fixed a faulty function name.
Tested to work with enabling modules from both the module page and with drush.

Comment #13

czigor commented 10 January 2012 at 07:22

Status:

Needs review

» Reviewed & tested by the community

Thanks Sutharsan! It's working with enabling modules from module page, drush and install profile too.

Comment #14

czigor commented 13 January 2012 at 12:36

Status:

Reviewed & tested by the community

» Needs work

Now it seems to me that it is not working. When the patch is applied I get a completely white page after the translations import phase of my custom install profile. However, I can go to the site as if the install had succeeded but I see this notice:

Notice: Undefined index: naplart_subject_hacks l10n_update_project_refresh() függvényben (/home/czigor/public_html/zenede/sites/all/modules/patched/l10n_update/l10n_update.project.inc 139 sor).

The naplart_subject_hacks has neither a project line in the naplart_subject_hacks.info file nor a po file anywhere.

Other translations seem to get imported just right.

When the patch is not applied the translations are not imported but I don't have the aformentioned completely white page.

Comment #15

sutharsan commented 13 January 2012 at 14:17

Status:

Needs work

» Needs review

Status	File	Size
new	l10n_update-implement_hook_modules_enable-1338886-15.patch	4.21 KB

This patch should do better.

Comment #16

sutharsan commented 21 January 2012 at 18:47

@czigor, can you test again with the last patch?

Comment #17

czigor commented 23 January 2012 at 08:20

Status:

Needs review

» Needs work

Works:
1. Site-install-time import of translations for modules that are install profile dependencies (both contrib and custom modules).
2. Module-enable-time import of translations for any module.

What does not work:
I have modules that I enable in my install profile NOT via dependency but by calling module_enable(). (If it's interesting why I do this I can go into details but I think it's irrelevant.) The translations of these modules do not get imported. These are custom modules with po files in sites/all/translations.

I can import these translations at admin/config/regional/translate/update after site install without any problem.

Thanks a lot for working on this!

Comment #18

czigor commented 23 January 2012 at 15:29

When the patch is applied and
drush en views_ui
I get the following warning:
Invalid argument supplied for foreach() l10n_update.check.inc:56 [warning]

Probably just a misconfigured files folder.

Comment #19

sutharsan commented 23 January 2012 at 16:49

Status:

Needs work

» Needs review

If you want to import translations of custom modules, you have to do the following:

the module's .info file must contain a 'project' definition OR implement a hook_l10n_update_projects_alter() definition as described in l10n_update.api.php. If you do this correctly, the module will be listed on the translations update page.
The translation file name has the syntax of -..po as described in the README.txt

Note that I fixed some relevant documentation typos just an hour ago.

I'm not sure if your method of enabling module will be supported. Enabling a module during the enable cycle of another module sounds awkward.

Comment #20

czigor commented 23 January 2012 at 22:21

Status:

Needs review

» Needs work

It's not inside another enable cycle but an install task in which I call module_enable().

(Sidenote, not sure if it's relevant: I need to do this for modules that depend on a feature that would be overriden if I just made them as a dependecy of the install profile, see
http://kybest.hu/en/blog/installation-profile-default-features-instead-o...)

Comment #21

sutharsan commented 23 January 2012 at 23:01

Status:

Needs work

» Needs review

Ah, that clarifies the situation. I've created a tiny custom module. In the install file the code:

function mycustom_install() {
  module_enable(array('search404', 'module_filter'), FALSE);
}

Works as advertized. Enable the custom module and Search 404 and Module Filter are enabled and translations are downloaded and installed.

To import local translations, just follow the instruction in #23. No need for zenede_profile_install_tasks().

Comment #22

czigor commented 24 January 2012 at 14:01

Status:

Needs review

» Needs work

I can still see 2 problems:

1. My local translations do not get imported if the module is enabled in an install profile task. I'm not importing the translations by hand in the install profile, just calling module_enable().

My translations are in sites/all/translations folder, the corresponding modules' info files have the necessary project and version lines which is confirmed by the fact that after install they appear on the admin/config/regional/translate/update page and from here the translations get imported correctly. (I'm not sure what #23 in the previous comment is referring to.)

2. On localhost my install profile is running just fine. However, on a server where safe mode is enabled I'm getting the following error just after the install profile dependencies are enabled:

An AJAX HTTP error occurred. HTTP Result Code: 200 Debugging information follows. Path: xxxxxxxxxxxx/install.php?profile=naplart_profile&locale=hu&id=1&op=do StatusText: OK ResponseText: Home | Drupal @import url("xxxxxxxxxxxx/modules/system/system.messages.css?0"); @import url("xxxxxxxxxxxx/modules/system/system.menus.css?0"); @import url("xxxxxxxxxxxx/modules/system/system.theme.css?0"); @import url("xxxxxxxxxxxx/modules/system/system.base.css?0"); @import url("xxxxxxxxxxxx/sites/all/modules/contrib/date/date_api/date.css?0"); @import url("xxxxxxxxxxxx/sites/all/modules/contrib/date/date_popup/themes/datepicker.1.7.css?0"); @import url("xxxxxxxxxxxx/modules/field/theme/field.css?0"); @import url("xxxxxxxxxxxx/modules/node/node.css?0"); @import url("xxxxxxxxxxxx/modules/user/user.css?0"); @import url("xxxxxxxxxxxx/sites/all/modules/contrib/views/css/views.css?0"); @import url("xxxxxxxxxxxx/modules/system/system.admin.css?0"); @import url("xxxxxxxxxxxx/modules/system/system.maintenance.css?0"); @import url("xxxxxxxxxxxx/sites/all/libraries/chosen/chosen/chosen.css?0"); @import url("xxxxxxxxxxxx/sites/all/modules/dev/ctools/css/ctools.css?0"); @import url("xxxxxxxxxxxx/themes/seven/reset.css?0"); @import url("xxxxxxxxxxxx/themes/seven/style.css?0"); Home Installation tasksProfil kiválasztása(done)Nyelv kiválasztása(done)Követelmények ellenőrzése(done)Adatbázis beállítás(done)Telepítési profil(active)Webhely beállításaJellemzők beállításaAlapértelmezések létrehozásaKész Warning message The Date API requires that you set up the <a href="/?q=admin/config/regional/settings">site timezone and first day of week settings</a> and the <a href="/?q=admin/config/regional/date-time">date format settings</a> to function correctly. SQLSTATE[23000]: Integrity constraint violation: 1062 Duplicate entry 'transliteration' for key 'PRIMARY'

EDIT: Without the patch in #15 this error message does not appear. I'm using the latest dev.

This core patch is applied: http://drupal.org/node/1240256#comment-5335164

Comment #23

sutharsan commented 24 January 2012 at 14:39

Status:

Needs work

» Needs review

Re. 1
I meant the instructions in #19. Check these or debug the code. Not much I can help.

Re 2
Is this the same problem or another one? "localhost my install profile is running just fine" do you mean with #15 applied?
Safe mode is not supported. See http://drupal.org/requirements
The core patch is not likely to change anything for this issue since import of local po files does not involve any copy or write operation.
I can't help you further since I can not reproduce the situation. And since your localhost works correctly, I advice you to debug the drupal site on the server and let us know what solution you have found.

Comment #24

sutharsan commented 3 February 2012 at 22:46

Status:

Needs review

» Fixed

Status	File	Size
new	l10n_update-implement_hook_modules_enable-1338886-24.patch	4.23 KB

Patch re-rolled for latest dev release. Patch committed.

No response on my latest comment, I assume you fixed it. If the problem persists feel free to re-open the issue.

Comment #25

17 February 2012 at 22:50

Status:

Fixed

» Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.

Comment #25.0

(not verified) commented 17 February 2012 at 22:50

Issue summary:

View changes

Change to

Start import process when modules/themes are enabled/installed

Comments

Comment #1

Comment #2

Comment #3

Comment #4

Comment #5

Comment #7

Comment #8

Comment #9

Comment #10

Comment #11

Comment #12

Comment #13

Comment #14

Comment #15

Comment #16

Comment #17

Comment #18

Comment #19

Comment #20

Comment #21

Comment #22

Comment #23

Comment #24

Comment #25

Comment #25.0

News items

Our community

Documentation

Drupal code base

Governance of community