Change language of default mapi folders

From Zarafa wiki

(Difference between revisions)
Jump to: navigation, search
m (→Errors)
 
(9 intermediate revisions not shown)
Line 5: Line 5:
-
Prerequisites for the script:
+
==Prerequisites==
* Run the script on a server which has the php mapi extention installed.
* Run the script on a server which has the php mapi extention installed.
* You need to have the php-cli package installed.
* You need to have the php-cli package installed.
-
* You need to have the locales installed of the languages you want to use.
+
* You need to have the locales installed of the languages you want to use. (For example language-support-nl).
 +
* You need to allow php short tags. (configurable in php.ini)
 +
==Errors==
 +
If you get this error:
 +
<pre>
 +
PHP Fatal error:  Call to undefined function mapi_make_scode() in /usr/share/php/mapi/mapicode.php on line XX
 +
</pre>
 +
 +
You need to make shure the extension=mapi.so is included in the php if used for command line tooling, for Debian/Ubuntu based distributions you can solve this by copying the zarafa.ini.
 +
 +
<pre>
 +
cp /etc/php5/apache2/conf.d/zarafa.ini /etc/php5/conf.d/
 +
</pre>
 +
 +
==Testing==
You can test the translation to a certain language to see if everything is installed correctly. A cli example to test a dutch translation:
You can test the translation to a certain language to see if everything is installed correctly. A cli example to test a dutch translation:
<pre>
<pre>
Line 23: Line 37:
-
The php script:
+
==Script for ZCP 6.*==
<pre>
<pre>
#!/usr/bin/php
#!/usr/bin/php
Line 58: Line 72:
-
function translate($lang)  
+
function translate($lang, $test=0)  
{
{
   global $LOCALE_PATH;
   global $LOCALE_PATH;
   putenv("LANGUAGE=$lang");
   putenv("LANGUAGE=$lang");
   bindtextdomain("zarafa", "$LOCALE_PATH");
   bindtextdomain("zarafa", "$LOCALE_PATH");
-
   bind_textdomain_codeset('zarafa', "UTF-8");
+
   if ($test == 0) {
 +
    bind_textdomain_codeset('zarafa', "windows-1252");
 +
  }
   textdomain('zarafa');
   textdomain('zarafa');
   setlocale(LC_ALL,$lang);
   setlocale(LC_ALL,$lang);
Line 93: Line 109:
if($argv[1] == "-t") {
if($argv[1] == "-t") {
-
   $trans_array=translate($argv[2]);
+
   $trans_array=translate($argv[2], 1);
   foreach ($trans_array as $key => $value) {
   foreach ($trans_array as $key => $value) {
     echo str_pad($key, 20, " ");
     echo str_pad($key, 20, " ");
Line 155: Line 171:
renamefolder($userstore, $inboxprops[PR_IPM_TASK_ENTRYID], $trans_array["Tasks"]);
renamefolder($userstore, $inboxprops[PR_IPM_TASK_ENTRYID], $trans_array["Tasks"]);
renamefolder($userstore, $rootprops[PR_ADDITIONAL_REN_ENTRYIDS][4], $trans_array["Junk E-mail"]);
renamefolder($userstore, $rootprops[PR_ADDITIONAL_REN_ENTRYIDS][4], $trans_array["Junk E-mail"]);
 +
 +
?>
 +
</pre>
 +
 +
==Script for ZCP 7.*==
 +
<pre>
 +
#!/usr/bin/php
 +
<?PHP
 +
 +
$LOCALE_PATH = '/usr/share/locale';
 +
 +
function isUnicodeStore($store) {
 +
                $supportmask = mapi_getprops($store, array(PR_STORE_SUPPORT_MASK));
 +
                if (isset($supportmask[PR_STORE_SUPPORT_MASK]) && ($supportmask[PR_STORE_SUPPORT_MASK] & STORE_UNICODE_OK)) {
 +
                        print("Store supports properties containing Unicode characters.\n");
 +
                        define('STORE_SUPPORTS_UNICODE', true);
 +
                } else {
 +
                        print("Store does not support properties containing Unicode characters.\n");
 +
                        define('STORE_SUPPORTS_UNICODE', false);
 +
                }
 +
}
 +
 +
function renamefolder($store, $entryid, $name)
 +
{
 +
    if(!$entryid) {
 +
        print("Unable to find $name folder\n");
 +
        return;
 +
    }
 +
 +
    $folder = mapi_msgstore_openentry($store, $entryid);
 +
    if(!$folder) {
 +
        print("Unable to open folder " . bin2hex($entryid) . "\n");
 +
        return;
 +
    }
 +
    mapi_setprops($folder, array(PR_DISPLAY_NAME => $name));
 +
 +
    if(mapi_last_hresult() != 0)
 +
        print("Unable to rename " . bin2hex($entryid) . " to '$name'\n");
 +
    else
 +
        print("Renamed " . bin2hex($entryid) . " to '$name'\n");
 +
}
 +
 +
include('/usr/share/php/mapi/mapi.util.php');
 +
include('/usr/share/php/mapi/mapidefs.php');
 +
include('/usr/share/php/mapi/mapicode.php');
 +
include('/usr/share/php/mapi/mapitags.php');
 +
include('/usr/share/php/mapi/mapiguid.php');
 +
 +
 +
function translate($lang, $test=0)
 +
{
 +
  global $LOCALE_PATH;
 +
  putenv("LANGUAGE=$lang");
 +
  bindtextdomain("zarafa", "$LOCALE_PATH");
 +
  if (STORE_SUPPORTS_UNICODE == false) {
 +
    bind_textdomain_codeset('zarafa', "windows-1252");
 +
  } else {
 +
    bind_textdomain_codeset('zarafa', "utf-8");
 +
  }
 +
  textdomain('zarafa');
 +
  setlocale(LC_ALL,$lang);
 +
  $trans_array["Sent Items"] = _("Sent Items");
 +
  $trans_array["Outbox"] = _("Outbox");
 +
  $trans_array["Deleted Items"] = _("Deleted Items");
 +
  $trans_array["Inbox"] =  _("Inbox");
 +
  $trans_array["Calendar"] = _("Calendar");
 +
  $trans_array["Contacts"] = _("Contacts");
 +
  $trans_array["Drafts"] = _("Drafts");
 +
  $trans_array["Journal"] = _("Journal");
 +
  $trans_array["Notes"] = _("Notes");
 +
  $trans_array["Tasks"] = _("Tasks");
 +
  $trans_array["Junk E-mail"] = _("Junk E-mail");
 +
  return $trans_array;
 +
}
 +
 +
 +
 +
if(count($argv) != 3) {
 +
    print("Usage: foldernames <useraccount> <language>\n");
 +
    print("\n");
 +
    print("To do a test translation, use:  -t <language>\n");
 +
    print("\n");
 +
    print("A <language> could be: nl_NL.UTF-8\n");
 +
    print("\n");
 +
    exit(2);
 +
}
 +
 +
if($argv[1] == "-t") {
 +
  define('STORE_SUPPORTS_UNICODE', true);
 +
  $trans_array=translate($argv[2], 1);
 +
  foreach ($trans_array as $key => $value) {
 +
    echo str_pad($key, 20, " ");
 +
    echo "$value\n";
 +
  }
 +
  exit(0);
 +
}
 +
 +
$session = mapi_logon_zarafa("SYSTEM", "", "file:///var/run/zarafa");
 +
$msgstorestable = mapi_getmsgstorestable($session);
 +
$msgstores = mapi_table_queryallrows($msgstorestable, array(PR_DEFAULT_STORE, PR_ENTRYID));
 +
 +
foreach ($msgstores as $row) {
 +
    if($row[PR_DEFAULT_STORE]) {
 +
        $storeentryid = $row[PR_ENTRYID];
 +
    }
 +
}
 +
 +
if(!$storeentryid) {
 +
    print "Can't find default store\n";
 +
    exit(1);
 +
}
 +
 +
$store = mapi_openmsgstore($session, $storeentryid);
 +
 +
if(!$store) {
 +
    print "Unable to open system store\n";
 +
    exit(1);
 +
}
 +
 +
$userstoreentryid = mapi_msgstore_createentryid($store, $argv[1]);
 +
if(!$userstoreentryid) {
 +
    print "Unknown user\n";
 +
    exit(1);
 +
}
 +
 +
$userstore = mapi_openmsgstore($session, $userstoreentryid);
 +
if(!$userstore) {
 +
    print "Unable to open user store\n";
 +
    exit(1);
 +
}
 +
 +
isUnicodeStore($userstore);
 +
 +
$inbox = mapi_msgstore_getreceivefolder($userstore);
 +
$root = mapi_msgstore_openentry($userstore);
 +
 +
$storeprops = mapi_getprops($userstore, array(PR_IPM_SENTMAIL_ENTRYID, PR_IPM_OUTBOX_ENTRYID, PR_IPM_WASTEBASKET_ENTRYID));
 +
$inboxprops = mapi_getprops($inbox, array(PR_ENTRYID, PR_IPM_APPOINTMENT_ENTRYID, PR_IPM_CONTACT_ENTRYID, PR_IPM_DRAFTS_ENTRYID, PR_IPM_JOURNAL_ENTRYID, PR_IPM_NOTE_ENTRYID, PR_IPM_TASK_ENTRYID));
 +
$rootprops = mapi_getprops($root, array(PR_ADDITIONAL_REN_ENTRYIDS));
 +
 +
$trans_array = translate($argv[2]);
 +
 +
renamefolder($userstore, $storeprops[PR_IPM_SENTMAIL_ENTRYID], $trans_array["Sent Items"]);
 +
renamefolder($userstore, $storeprops[PR_IPM_OUTBOX_ENTRYID], $trans_array["Outbox"]);
 +
renamefolder($userstore, $storeprops[PR_IPM_WASTEBASKET_ENTRYID], $trans_array["Deleted Items"]);
 +
renamefolder($userstore, $inboxprops[PR_ENTRYID], $trans_array["Inbox"]);
 +
renamefolder($userstore, $inboxprops[PR_IPM_APPOINTMENT_ENTRYID], $trans_array["Calendar"]);
 +
renamefolder($userstore, $inboxprops[PR_IPM_CONTACT_ENTRYID], $trans_array["Contacts"]);
 +
renamefolder($userstore, $inboxprops[PR_IPM_DRAFTS_ENTRYID], $trans_array["Drafts"]);
 +
renamefolder($userstore, $inboxprops[PR_IPM_JOURNAL_ENTRYID], $trans_array["Journal"]);
 +
renamefolder($userstore, $inboxprops[PR_IPM_NOTE_ENTRYID], $trans_array["Notes"]);
 +
renamefolder($userstore, $inboxprops[PR_IPM_TASK_ENTRYID], $trans_array["Tasks"]);
 +
renamefolder($userstore, $rootprops[PR_ADDITIONAL_REN_ENTRYIDS][4], $trans_array["Junk E-mail"]);
 +
 +
?>
</pre>
</pre>

Latest revision as of 16:32, 10 January 2013


After a user store is created it is not possible to change the language of the default mapi folders (Inbox, Outbox, etc).

Below is a php script that can change the language of the default mapi folders. You need to run this script on the zarafa server.


Contents

Prerequisites

  • Run the script on a server which has the php mapi extention installed.
  • You need to have the php-cli package installed.
  • You need to have the locales installed of the languages you want to use. (For example language-support-nl).
  • You need to allow php short tags. (configurable in php.ini)

Errors

If you get this error: 

PHP Fatal error:  Call to undefined function mapi_make_scode() in /usr/share/php/mapi/mapicode.php on line XX

You need to make shure the extension=mapi.so is included in the php if used for command line tooling, for Debian/Ubuntu based distributions you can solve this by copying the zarafa.ini. 

cp /etc/php5/apache2/conf.d/zarafa.ini /etc/php5/conf.d/

Testing

You can test the translation to a certain language to see if everything is installed correctly. A cli example to test a dutch translation: 

./foldernames.php -t nl_NL.UTF-8


A cli example to rename the default folders of a zarafa user to dutch: 

./foldernames.php [zarafa-user] nl_NL.UTF-8


Script for ZCP 6.*

#!/usr/bin/php

<?

$LOCALE_PATH = '/usr/share/locale';

function renamefolder($store, $entryid, $name)
{
    if(!$entryid) {
        print("Unable to find $name folder\n");
        return;
    }
    
    $folder = mapi_msgstore_openentry($store, $entryid);
    if(!$folder) {
        print("Unable to open folder " . bin2hex($entryid) . "\n");
        return;
    }
    mapi_setprops($folder, array(PR_DISPLAY_NAME => $name));
    
    if(mapi_last_hresult() != 0)
        print("Unable to rename " . bin2hex($entryid) . " to '$name'\n");
    else
        print("Renamed " . bin2hex($entryid) . " to '$name'\n");
}

include('/usr/share/php/mapi/mapi.util.php');
include('/usr/share/php/mapi/mapidefs.php');
include('/usr/share/php/mapi/mapicode.php');
include('/usr/share/php/mapi/mapitags.php');
include('/usr/share/php/mapi/mapiguid.php');


function translate($lang, $test=0) 
{
  global $LOCALE_PATH;
  putenv("LANGUAGE=$lang");
  bindtextdomain("zarafa", "$LOCALE_PATH");
  if ($test == 0) {
    bind_textdomain_codeset('zarafa', "windows-1252");
  }
  textdomain('zarafa');
  setlocale(LC_ALL,$lang);
  $trans_array["Sent Items"] = _("Sent Items");
  $trans_array["Outbox"] = _("Outbox");
  $trans_array["Deleted Items"] = _("Deleted Items");
  $trans_array["Inbox"] =  _("Inbox");
  $trans_array["Calendar"] = _("Calendar");
  $trans_array["Contacts"] = _("Contacts");
  $trans_array["Drafts"] = _("Drafts");
  $trans_array["Journal"] = _("Journal");
  $trans_array["Notes"] = _("Notes");
  $trans_array["Tasks"] = _("Tasks");
  $trans_array["Junk E-mail"] = _("Junk E-mail");
  return $trans_array;
} 



if(count($argv) != 3) {
    print("Usage: foldernames <useraccount> <language>\n");
    print("\n");
    print("To do a test translation, use:  -t <language>\n");
    print("\n");
    print("A <language> could be: nl_NL.UTF-8\n");
    print("\n");
    exit(2);
}

if($argv[1] == "-t") {
  $trans_array=translate($argv[2], 1);
  foreach ($trans_array as $key => $value) {
    echo str_pad($key, 20, " ");
    echo "$value\n";
  } 
  exit(0);
}

$session = mapi_logon_zarafa("SYSTEM", "", "file:///var/run/zarafa");
$msgstorestable = mapi_getmsgstorestable($session);
$msgstores = mapi_table_queryallrows($msgstorestable, array(PR_DEFAULT_STORE, PR_ENTRYID));

foreach ($msgstores as $row) {
    if($row[PR_DEFAULT_STORE]) {
        $storeentryid = $row[PR_ENTRYID];
    }
}

if(!$storeentryid) {
    print "Can't find default store\n";
    exit(1);
}

$store = mapi_openmsgstore($session, $storeentryid);

if(!$store) {
    print "Unable to open system store\n";
    exit(1);
}

$userstoreentryid = mapi_msgstore_createentryid($store, $argv[1]);
if(!$userstoreentryid) {
    print "Unknown user\n";
    exit(1);
}

$userstore = mapi_openmsgstore($session, $userstoreentryid);
if(!$userstore) {
    print "Unable to open user store\n";
    exit(1);
}

$inbox = mapi_msgstore_getreceivefolder($userstore);
$root = mapi_msgstore_openentry($userstore);

$storeprops = mapi_getprops($userstore, array(PR_IPM_SENTMAIL_ENTRYID, PR_IPM_OUTBOX_ENTRYID, PR_IPM_WASTEBASKET_ENTRYID));
$inboxprops = mapi_getprops($inbox, array(PR_ENTRYID, PR_IPM_APPOINTMENT_ENTRYID, PR_IPM_CONTACT_ENTRYID, PR_IPM_DRAFTS_ENTRYID, PR_IPM_JOURNAL_ENTRYID, PR_IPM_NOTE_ENTRYID, PR_IPM_TASK_ENTRYID));
$rootprops = mapi_getprops($root, array(PR_ADDITIONAL_REN_ENTRYIDS));

$trans_array = translate($argv[2]);

renamefolder($userstore, $storeprops[PR_IPM_SENTMAIL_ENTRYID], $trans_array["Sent Items"]);
renamefolder($userstore, $storeprops[PR_IPM_OUTBOX_ENTRYID], $trans_array["Outbox"]);
renamefolder($userstore, $storeprops[PR_IPM_WASTEBASKET_ENTRYID], $trans_array["Deleted Items"]);
renamefolder($userstore, $inboxprops[PR_ENTRYID], $trans_array["Inbox"]);
renamefolder($userstore, $inboxprops[PR_IPM_APPOINTMENT_ENTRYID], $trans_array["Calendar"]);
renamefolder($userstore, $inboxprops[PR_IPM_CONTACT_ENTRYID], $trans_array["Contacts"]);
renamefolder($userstore, $inboxprops[PR_IPM_DRAFTS_ENTRYID], $trans_array["Drafts"]);
renamefolder($userstore, $inboxprops[PR_IPM_JOURNAL_ENTRYID], $trans_array["Journal"]);
renamefolder($userstore, $inboxprops[PR_IPM_NOTE_ENTRYID], $trans_array["Notes"]);
renamefolder($userstore, $inboxprops[PR_IPM_TASK_ENTRYID], $trans_array["Tasks"]);
renamefolder($userstore, $rootprops[PR_ADDITIONAL_REN_ENTRYIDS][4], $trans_array["Junk E-mail"]);

?>

Script for ZCP 7.*

#!/usr/bin/php
<?PHP

$LOCALE_PATH = '/usr/share/locale';

function isUnicodeStore($store) {
                $supportmask = mapi_getprops($store, array(PR_STORE_SUPPORT_MASK));
                if (isset($supportmask[PR_STORE_SUPPORT_MASK]) && ($supportmask[PR_STORE_SUPPORT_MASK] & STORE_UNICODE_OK)) {
                        print("Store supports properties containing Unicode characters.\n");
                        define('STORE_SUPPORTS_UNICODE', true);
                } else {
                        print("Store does not support properties containing Unicode characters.\n");
                        define('STORE_SUPPORTS_UNICODE', false);
                }
}

function renamefolder($store, $entryid, $name)
{
    if(!$entryid) {
        print("Unable to find $name folder\n");
        return;
    }

    $folder = mapi_msgstore_openentry($store, $entryid);
    if(!$folder) {
        print("Unable to open folder " . bin2hex($entryid) . "\n");
        return;
    }
    mapi_setprops($folder, array(PR_DISPLAY_NAME => $name));

    if(mapi_last_hresult() != 0)
        print("Unable to rename " . bin2hex($entryid) . " to '$name'\n");
    else
        print("Renamed " . bin2hex($entryid) . " to '$name'\n");
}

include('/usr/share/php/mapi/mapi.util.php');
include('/usr/share/php/mapi/mapidefs.php');
include('/usr/share/php/mapi/mapicode.php');
include('/usr/share/php/mapi/mapitags.php');
include('/usr/share/php/mapi/mapiguid.php');


function translate($lang, $test=0)
{
  global $LOCALE_PATH;
  putenv("LANGUAGE=$lang");
  bindtextdomain("zarafa", "$LOCALE_PATH");
  if (STORE_SUPPORTS_UNICODE == false) {
    bind_textdomain_codeset('zarafa', "windows-1252");
  } else {
    bind_textdomain_codeset('zarafa', "utf-8");
  }
  textdomain('zarafa');
  setlocale(LC_ALL,$lang);
  $trans_array["Sent Items"] = _("Sent Items");
  $trans_array["Outbox"] = _("Outbox");
  $trans_array["Deleted Items"] = _("Deleted Items");
  $trans_array["Inbox"] =  _("Inbox");
  $trans_array["Calendar"] = _("Calendar");
  $trans_array["Contacts"] = _("Contacts");
  $trans_array["Drafts"] = _("Drafts");
  $trans_array["Journal"] = _("Journal");
  $trans_array["Notes"] = _("Notes");
  $trans_array["Tasks"] = _("Tasks");
  $trans_array["Junk E-mail"] = _("Junk E-mail");
  return $trans_array;
}



if(count($argv) != 3) {
    print("Usage: foldernames <useraccount> <language>\n");
    print("\n");
    print("To do a test translation, use:  -t <language>\n");
    print("\n");
    print("A <language> could be: nl_NL.UTF-8\n");
    print("\n");
    exit(2);
}

if($argv[1] == "-t") {
  define('STORE_SUPPORTS_UNICODE', true);
  $trans_array=translate($argv[2], 1);
  foreach ($trans_array as $key => $value) {
    echo str_pad($key, 20, " ");
    echo "$value\n";
  }
  exit(0);
}

$session = mapi_logon_zarafa("SYSTEM", "", "file:///var/run/zarafa");
$msgstorestable = mapi_getmsgstorestable($session);
$msgstores = mapi_table_queryallrows($msgstorestable, array(PR_DEFAULT_STORE, PR_ENTRYID));

foreach ($msgstores as $row) {
    if($row[PR_DEFAULT_STORE]) {
        $storeentryid = $row[PR_ENTRYID];
    }
}

if(!$storeentryid) {
    print "Can't find default store\n";
    exit(1);
}

$store = mapi_openmsgstore($session, $storeentryid);

if(!$store) {
    print "Unable to open system store\n";
    exit(1);
}

$userstoreentryid = mapi_msgstore_createentryid($store, $argv[1]);
if(!$userstoreentryid) {
    print "Unknown user\n";
    exit(1);
}

$userstore = mapi_openmsgstore($session, $userstoreentryid);
if(!$userstore) {
    print "Unable to open user store\n";
    exit(1);
}

isUnicodeStore($userstore);

$inbox = mapi_msgstore_getreceivefolder($userstore);
$root = mapi_msgstore_openentry($userstore);

$storeprops = mapi_getprops($userstore, array(PR_IPM_SENTMAIL_ENTRYID, PR_IPM_OUTBOX_ENTRYID, PR_IPM_WASTEBASKET_ENTRYID));
$inboxprops = mapi_getprops($inbox, array(PR_ENTRYID, PR_IPM_APPOINTMENT_ENTRYID, PR_IPM_CONTACT_ENTRYID, PR_IPM_DRAFTS_ENTRYID, PR_IPM_JOURNAL_ENTRYID, PR_IPM_NOTE_ENTRYID, PR_IPM_TASK_ENTRYID));
$rootprops = mapi_getprops($root, array(PR_ADDITIONAL_REN_ENTRYIDS));

$trans_array = translate($argv[2]);

renamefolder($userstore, $storeprops[PR_IPM_SENTMAIL_ENTRYID], $trans_array["Sent Items"]);
renamefolder($userstore, $storeprops[PR_IPM_OUTBOX_ENTRYID], $trans_array["Outbox"]);
renamefolder($userstore, $storeprops[PR_IPM_WASTEBASKET_ENTRYID], $trans_array["Deleted Items"]);
renamefolder($userstore, $inboxprops[PR_ENTRYID], $trans_array["Inbox"]);
renamefolder($userstore, $inboxprops[PR_IPM_APPOINTMENT_ENTRYID], $trans_array["Calendar"]);
renamefolder($userstore, $inboxprops[PR_IPM_CONTACT_ENTRYID], $trans_array["Contacts"]);
renamefolder($userstore, $inboxprops[PR_IPM_DRAFTS_ENTRYID], $trans_array["Drafts"]);
renamefolder($userstore, $inboxprops[PR_IPM_JOURNAL_ENTRYID], $trans_array["Journal"]);
renamefolder($userstore, $inboxprops[PR_IPM_NOTE_ENTRYID], $trans_array["Notes"]);
renamefolder($userstore, $inboxprops[PR_IPM_TASK_ENTRYID], $trans_array["Tasks"]);
renamefolder($userstore, $rootprops[PR_ADDITIONAL_REN_ENTRYIDS][4], $trans_array["Junk E-mail"]);

?>
Retrieved from "http://www.zarafa.com/wiki/index.php/Change_language_of_default_mapi_folders"
Personal tools