Merge lp:~townsend/libunity/fix-search-hint-localization into lp:~unity-team/libunity/libunity-7.0

[Christopher Townsend]

Add support to localize the initial search hint and home string.

The initial search hint in the Dash Search bar is not translated. This MP fixes the default search hint. A fix is also needed in unity-scope-home and also a unity-scope-home gettext domain is needed for the various different languages.

I tested this by first creating a unity-scope-home.mo file by coalescing the unity-lens-*.mo files by first running msgunfmt on those .mo files and converting them to .po files and then taking all of those and creating one big unity-scope-home.po file and then running msgfmt on that. I did this in Spanish since I can marginally read Spanish:)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:353
http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-ci/34/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-raring-amd64-ci/34/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-libunity-libunity-7.0-ci/34/rebuild

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:354
http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-ci/35/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-raring-amd64-ci/35/console

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-libunity-libunity-7.0-ci/35/rebuild

review: Needs Fixing (continuous-integration)

[Christopher Townsend (townsend)]

Looking at the Jenkins log, a test is failing that is not a result of this MP.

[Christopher Townsend (townsend)]

I'm wrong, the Jenkins failure is caused by this MP, but it's unclear why it would fail. Will investigate.

[Christopher Townsend (townsend)]

Ok, I see what the problem is now. The test masterscope_x.scope files do not contain the Desktop Entry part of the normal scope files and in turn, don't have X-Ubuntu-Gettext-Domain.

I will fix up these test scope files.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:356
http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-ci/39/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-raring-amd64-ci/39

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-libunity-libunity-7.0-ci/39/rebuild

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

> Ok, I see what the problem is now. The test masterscope_x.scope files do not
> contain the Desktop Entry part of the normal scope files and in turn, don't
> have X-Ubuntu-Gettext-Domain.
>
> I will fix up these test scope files.

Sorry for taking so long to review this, ping us next time ;)
Wouldn't it be better to make the domain optional instead of failing if it's not there?

review: Needs Fixing

[Christopher Townsend (townsend)]

Hi Michal,

Ah, I forgot about this MP:) No worries!

Based on your review comment, are you saying that X-Ubuntu-Gettext-Domain would be an optional field in any .scope file? It's not clear to me if it should be, but it seems like it is always included in the .scope files and in the .lens files in 13.04. I assumed it was required based on 13.04 and seeing that all .scopes files in '100 scopes' have it included.

If it is required, then I think the code I have in place now should be used since it would be a failure if it's not there. If it's supposed to be optional, then yeah, I need to add some logic to handle the cases where it's not there.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:357
http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-ci/55/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-raring-amd64-ci/55

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-libunity-libunity-7.0-ci/55/rebuild

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

> Hi Michal,
>
> Ah, I forgot about this MP:) No worries!
>
> Based on your review comment, are you saying that X-Ubuntu-Gettext-Domain
> would be an optional field in any .scope file? It's not clear to me if it
> should be, but it seems like it is always included in the .scope files and in
> the .lens files in 13.04. I assumed it was required based on 13.04 and seeing
> that all .scopes files in '100 scopes' have it included.
>

Yes, conceptually it's a .desktop file key in a scope file, so it's quite likely that we'll want to change that at some point, therefore it shouldn't be a required field.

> If it is required, then I think the code I have in place now should be used
> since it would be a failure if it's not there. If it's supposed to be
> optional, then yeah, I need to add some logic to handle the cases where it's
> not there.

Yes, please adjust the logic to make it not fail if the key is not there (plus revert at least one test .scope file to also test that possibility.

[Christopher Townsend (townsend)]

Ok, I added logic to check if the "Desktop Entry" group and the X-Ubuntu-Gettext-Domain key exist. Also removed those entries in a couple of test scope files to make sure that the logic works for both cases.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:359
http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-ci/60/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-raring-amd64-ci/60

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-libunity-libunity-7.0-ci/60/rebuild

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

8 +#############################################
9 +# Gettext
10 +#############################################
11 +GETTEXT_PACKAGE="..."
12 +AC_SUBST(GETTEXT_PACKAGE)
13 +

There's already a Gettext section, could you move it there pls?

review: Needs Fixing

[lp:~townsend/libunity/fix-search-hint-localization]

360. By Christopher Townsend on 2013-04-24

A previous commit added an unnecessary Gettext section. Move the added configuration vars to the already existing Gettext section.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:360
http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-ci/62/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-raring-amd64-ci/62

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-libunity-libunity-7.0-ci/62/rebuild

review: Approve (continuous-integration)

[lp:~townsend/libunity/fix-search-hint-localization]

361. By Christopher Townsend on 2013-04-24

Using "..." for the GETTEXT_PACKAGE is not advised. Use $PACKAGE for that instead.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:361
http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-ci/63/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-team-libunity-libunity-7.0-raring-amd64-ci/63

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-team-libunity-libunity-7.0-ci/63/rebuild

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

LGTM

review: Approve

=== modified file 'configure.ac'
--- configure.ac	2013-04-23 16:00:45 +0000
+++ configure.ac	2013-04-24 18:28:26 +0000
@@ -165,6 +165,8 @@
 # Gettext
 #############################################
 IT_PROG_INTLTOOL([0.40.0])
+GETTEXT_PACKAGE="$PACKAGE"
+AC_SUBST(GETTEXT_PACKAGE)
 
 #################################################
 # Docs

=== modified file 'protocol/Makefile.am'
--- protocol/Makefile.am	2013-02-26 12:56:52 +0000
+++ protocol/Makefile.am	2013-04-24 18:28:26 +0000
@@ -31,6 +31,7 @@
 libunity_protocol_private_la_CPPFLAGS = \
   -DG_LOG_DOMAIN=\"libunity-protocol-private\" \
   -DPKGDATADIR=\"$(PKGDATADIR)\" \
+  -DGETTEXT_PACKAGE=\"$(GETTEXT_PACKAGE)\" \
   -DDATADIR=\"$(DATADIR)\" \
   -I$(srcdir) \
   $(EXTRA_FLAGS) \

=== modified file 'protocol/protocol-scope-discovery.vala'
--- protocol/protocol-scope-discovery.vala	2013-03-26 11:37:24 +0000
+++ protocol/protocol-scope-discovery.vala	2013-04-24 18:28:26 +0000
@@ -114,10 +114,12 @@
   public class ScopeRegistry
   {
     private static const string SCOPE_GROUP = "Scope";
+    private static const string DESKTOP_GROUP = "Desktop Entry";
 
     public class ScopeMetadata
     {
       public string id;
+      public string domain;
       public string full_path;
       public string name;
       public string dbus_path;
@@ -140,8 +142,14 @@
 
       public void load_from_key_file (KeyFile file) throws Error
       {
+        this.domain = null;
+
+        // Get the Gettext-Domain first, if it exists
+        if (file.has_group (DESKTOP_GROUP) && file.has_key (DESKTOP_GROUP, "X-Ubuntu-Gettext-Domain"))
+            this.domain = file.get_string (DESKTOP_GROUP, "X-Ubuntu-Gettext-Domain");
+
         // required fields
-        this.name = file.get_string (SCOPE_GROUP, "Name");
+        this.name = dgettext(this.domain, file.get_string (SCOPE_GROUP, "Name"));
         this.dbus_name = file.get_string (SCOPE_GROUP, "DBusName");
         this.dbus_path = file.get_string (SCOPE_GROUP, "DBusPath");
         this.icon = file.get_string (SCOPE_GROUP, "Icon");
@@ -181,7 +189,7 @@
           this.description = file.get_string (SCOPE_GROUP, "Description");
 
         if (file.has_key (SCOPE_GROUP, "SearchHint"))
-          this.search_hint = file.get_string (SCOPE_GROUP, "SearchHint");
+          this.search_hint = dgettext(this.domain, file.get_string (SCOPE_GROUP, "SearchHint"));
 
         if (file.has_key (SCOPE_GROUP, "RequiredMetadata"))
           this.required_metadata = MetaDataSchemaInfo.from_string (file.get_string (SCOPE_GROUP, "RequiredMetadata"));

=== modified file 'test/data/unity/scopes/masterscope_b.scope'
--- test/data/unity/scopes/masterscope_b.scope	2012-12-04 16:34:36 +0000
+++ test/data/unity/scopes/masterscope_b.scope	2013-04-24 18:28:26 +0000
@@ -12,4 +12,7 @@
 Name=Sample Master Scope 2
 Description=Find even more stuff
 SearchHint=Search things
-Shortcut=w
\ No newline at end of file
+Shortcut=w
+
+[Desktop Entry]
+X-Ubuntu-Gettext-Domain=fakedomain

=== modified file 'test/data/unity/scopes/masterscope_b/subscope1.scope'
--- test/data/unity/scopes/masterscope_b/subscope1.scope	2012-12-04 16:34:36 +0000
+++ test/data/unity/scopes/masterscope_b/subscope1.scope	2013-04-24 18:28:26 +0000
@@ -10,4 +10,4 @@
 Name=Sample subscope 1
 Description=Find various stuff subscope 1
 SearchHint=Search stuff subscope 1
-Shortcut=x
\ No newline at end of file
+Shortcut=x

=== modified file 'test/data/unity/scopes/masterscope_b/subscope2.scope'
--- test/data/unity/scopes/masterscope_b/subscope2.scope	2012-12-04 16:34:36 +0000
+++ test/data/unity/scopes/masterscope_b/subscope2.scope	2013-04-24 18:28:26 +0000
@@ -8,4 +8,7 @@
 Name=Sample subscope 2
 Description=Find various stuff subscope 2
 SearchHint=Search stuff subscope 2
-Shortcut=u
\ No newline at end of file
+Shortcut=u
+
+[Desktop Entry]
+X-Ubuntu-Gettext-Domain=fakedomain

=== modified file 'test/data/unity/scopes/test_masterscope.scope'
--- test/data/unity/scopes/test_masterscope.scope	2013-01-23 16:05:24 +0000
+++ test/data/unity/scopes/test_masterscope.scope	2013-04-24 18:28:26 +0000
@@ -11,3 +11,6 @@
 Name=Sample Master Scope
 Description=Find various stuff
 SearchHint=Master search hint
+
+[Desktop Entry]
+X-Ubuntu-Gettext-Domain=fakedomain

=== modified file 'test/data/unity/scopes/test_masterscope/childscope_1.scope'
--- test/data/unity/scopes/test_masterscope/childscope_1.scope	2012-12-21 12:55:38 +0000
+++ test/data/unity/scopes/test_masterscope/childscope_1.scope	2013-04-24 18:28:26 +0000
@@ -10,3 +10,6 @@
 Name=Child scope 1
 Description=Find various stuff
 SearchHint=Search stuff
+
+[Desktop Entry]
+X-Ubuntu-Gettext-Domain=fakedomain

=== modified file 'test/data/unity/scopes/test_masterscope/childscope_2.scope'
--- test/data/unity/scopes/test_masterscope/childscope_2.scope	2012-12-21 12:55:38 +0000
+++ test/data/unity/scopes/test_masterscope/childscope_2.scope	2013-04-24 18:28:26 +0000
@@ -10,3 +10,6 @@
 Name=Child scope 2
 Description=Find various stuff
 SearchHint=Search stuff
+
+[Desktop Entry]
+X-Ubuntu-Gettext-Domain=fakedomain