Translate
In the UI interface, It only has need to insert the Microsoft translator key, but in the MT Enchanced provider dll API, it has to deal with client ID and client Key. It is confusing and embarrassing. It seems a bug.
I don't know how to add the plugin to Trados and add credential, how to use with Traods via code API, it is a disaster and frustrating.
Who has experience on that and can share your solution for me? Great thanks!
public class MtTranslationProviderWinFormsUI : ITranslationProviderWinFormsUI
{
private readonly Constants _constants = new Constants();
private Logger _logger = LogManager.GetCurrentClassLogger();
/// <summary>
/// Show the plug-in settings form when the user is adding the translation provider plug-in
/// through the GUI of SDL Trados Studio
/// </summary>
/// <param name="owner"></param>
/// <param name="languagePairs"></param>
/// <param name="credentialStore"></param>
/// <returns></returns>
private TranslationProviderCredential GetMyCredentials(ITranslationProviderCredentialStore credentialStore, string uri)
{
var myUri = new Uri(uri);
TranslationProviderCredential cred = null;
if (credentialStore.GetCredential(myUri) != null)
{
//get the credential to return
cred = new TranslationProviderCredential(credentialStore.GetCredential(myUri).Credential, credentialStore.GetCredential(myUri).Persist);
}
return cred;
}
private void SetMstCredentials(ITranslationProviderCredentialStore credentialStore, GenericCredentials creds, bool persistCred)
{ //used to set credentials
// we are only setting and getting credentials for the uri with no parameters...kind of like a master credential
var myUri = new Uri("mtenhancedprovidermst:///");
var cred = new TranslationProviderCredential(creds.ToCredentialString(), persistCred);
credentialStore.RemoveCredential(myUri);
credentialStore.AddCredential(myUri, cred);
}
private void SetGoogleCredentials(ITranslationProviderCredentialStore credentialStore, string apiKey, bool persistKey)
{ //used to set credentials
// we are only setting and getting credentials for the uri with no parameters...kind of like a master credential
var myUri = new Uri("mtenhancedprovidergt:///");
var cred = new TranslationProviderCredential(apiKey, persistKey);
credentialStore.RemoveCredential(myUri);
credentialStore.AddCredential(myUri, cred);
}
public ITranslationProvider[] Browse(IWin32Window owner, LanguagePair[] languagePairs, ITranslationProviderCredentialStore credentialStore)
{
//construct options to send to form
var loadOptions = new MtTranslationOptions();
//get saved key if there is one and put it into options
//get google credentials
var getCredGt = GetMyCredentials(credentialStore, "mtenhancedprovidergt:///");
if (getCredGt != null)
{
loadOptions.ApiKey = getCredGt.Credential;
loadOptions.PersistGoogleKey = getCredGt.Persist;
}
//get microsoft credentials
var getCredMt = GetMyCredentials(credentialStore, "mtenhancedprovidermst:///");
if (getCredMt != null)
{
try
{
var creds = new GenericCredentials(getCredMt.Credential); //parse credential into username and password
loadOptions.ClientId = creds.UserName;
loadOptions.ClientSecret = creds.Password;
loadOptions.PersistMicrosoftCreds = getCredMt.Persist;
}
catch(Exception ex) //swallow b/c it will just fail to fill in instead of crashing the whole program
{
_logger.Error($"{_constants.Browse} {ex.Message}\n { ex.StackTrace}");
}
}
var apiConnecter = new ApiConnecter(loadOptions);
var allSupportedLanguages = ApiConnecter.SupportedLangs;
var correspondingLanguages = languagePairs.Where(lp => allSupportedLanguages.Contains(lp.TargetCultureName.Substring(0,2))).ToList();
//loadOptions.LanguagesSupported = correspLanguages.ToDictionary(lp => lp.TargetCultureName, lp=>"MS Translator");
//construct form
var dialog = new MtProviderConfDialog(loadOptions, credentialStore, correspondingLanguages);
//we are letting user delete creds but after testing it seems that it's ok if the individual credentials are null, b/c our method will re-add them to the credstore based on the uri
if (dialog.ShowDialog(owner) == DialogResult.OK)
{
var testProvider = new MtTranslationProvider(dialog.Options);
var apiKey = dialog.Options.ApiKey;
//we are setting credentials selectively based on the chosen provider to avoid saving the other if it is blank
if (dialog.Options.SelectedProvider == MtTranslationOptions.ProviderType.GoogleTranslate)
{
//set google credential
SetGoogleCredentials(credentialStore, apiKey, dialog.Options.PersistGoogleKey);
}
else if (dialog.Options.SelectedProvider == MtTranslationOptions.ProviderType.MicrosoftTranslator)
{
//set mst cred
var creds2 = new GenericCredentials(dialog.Options.ClientId, dialog.Options.ClientSecret);
SetMstCredentials(credentialStore, creds2, dialog.Options.PersistMicrosoftCreds);
}
return new ITranslationProvider[] { testProvider };
}
return null;
}
/// <summary>
/// Determines whether the plug-in settings can be changed
/// by displaying the Settings button in SDL Trados Studio.
/// </summary>
public bool SupportsEditing
{
get { return true; }
}
/// <summary>
/// If the plug-in settings can be changed by the user,
/// SDL Trados Studio will display a Settings button.
/// By clicking this button, users raise the plug-in user interface,
/// in which they can modify any applicable settings, in our implementation
/// the delimiter character and the list file name.
/// </summary>
/// <param name="owner"></param>
/// <param name="translationProvider"></param>
/// <param name="languagePairs"></param>
/// <param name="credentialStore"></param>
/// <returns></returns>
public bool Edit(IWin32Window owner, ITranslationProvider translationProvider, LanguagePair[] languagePairs, ITranslationProviderCredentialStore credentialStore)
{
var editProvider = translationProvider as MtTranslationProvider;
if (editProvider == null)
{
return false;
}
//get saved key if there is one and put it into options
//get google credentials
var getCredGt = GetMyCredentials(credentialStore, "mtenhancedprovidergt:///");
if (getCredGt != null)
{
editProvider.Options.ApiKey = getCredGt.Credential;
editProvider.Options.PersistGoogleKey = getCredGt.Persist;
}
//get microsoft credentials
var getCredMt = GetMyCredentials(credentialStore, "mtenhancedprovidermst:///");
if (getCredMt != null)
{
try
{
var creds = new GenericCredentials(getCredMt.Credential); //parse credential into username and password
editProvider.Options.ClientId = creds.UserName;
editProvider.Options.ClientSecret = creds.Password;
editProvider.Options.PersistMicrosoftCreds = getCredMt.Persist;
}
catch(Exception ex) //swallow b/c it will just fail to fill in instead of crashing the whole program
{
_logger.Error($"{_constants.Edit} {ex.Message}\n { ex.StackTrace}");
}
}
var apiConnecter = new ApiConnecter(editProvider.Options);
var allSupportedLanguages = ApiConnecter.SupportedLangs;
var correspondingLanguages = languagePairs.Where(lp => allSupportedLanguages.Contains(lp.TargetCultureName.Substring(0,2))).ToList();
var dialog = new MtProviderConfDialog(editProvider.Options, credentialStore, correspondingLanguages);
//we are letting user delete creds but after testing it seems that it's ok if the individual credentials are null, b/c our method will re-add them to the credstore based on the uri
if (dialog.ShowDialog(owner) == DialogResult.OK)
{
editProvider.Options = dialog.Options;
var apiKey = editProvider.Options.ApiKey;
//we are setting credentials selectively based on the chosen provider to avoid saving the other if it is blank
if (dialog.Options.SelectedProvider == MtTranslationOptions.ProviderType.GoogleTranslate)
{
//set google credential
SetGoogleCredentials(credentialStore, apiKey, dialog.Options.PersistGoogleKey);
}
else if (dialog.Options.SelectedProvider == MtTranslationOptions.ProviderType.MicrosoftTranslator)
{
//set mst cred
var credentials = new GenericCredentials(dialog.Options.ClientId, dialog.Options.ClientSecret);
SetMstCredentials(credentialStore, credentials, dialog.Options.PersistMicrosoftCreds);
}
return true;
}
return false;
}
/// <summary>
/// This gets called when a TranslationProviderAuthenticationException is thrown
/// Since SDL Studio doesn't pass the provider instance here and even if we do a workaround...
/// any new options set in the form that comes up are never saved to the project XML...
/// so there is no way to change any options, only to provide the credentials
/// </summary>
/// <param name="owner"></param>
/// <param name="translationProviderUri"></param>
/// <param name="translationProviderState"></param>
/// <param name="credentialStore"></param>
/// <returns></returns>
public bool GetCredentialsFromUser(IWin32Window owner, Uri translationProviderUri, string translationProviderState, ITranslationProviderCredentialStore credentialStore)
{
var options = new MtTranslationOptions(translationProviderUri);
var caption = "Credentials"; //default in case any problem retrieving localized resource below
if (options.SelectedProvider == MtTranslationOptions.ProviderType.GoogleTranslate)
caption = PluginResources.PromptForCredentialsCaption_Google;
else if (options.SelectedProvider == MtTranslationOptions.ProviderType.MicrosoftTranslator)
caption = PluginResources.PromptForCredentialsCaption_Microsoft;
var dialog = new MtProviderConfDialog(options, caption, credentialStore);
dialog.DisableForCredentialsOnly(); //only show controls for setting credentials, as that is the only thing that will end up getting saved
if (dialog.ShowDialog(owner) == DialogResult.OK)
{
var apiKey = dialog.Options.ApiKey;
if (options.SelectedProvider == MtTranslationOptions.ProviderType.GoogleTranslate)
{
//set google credential
SetGoogleCredentials(credentialStore, apiKey, dialog.Options.PersistGoogleKey);
}
else if (options.SelectedProvider == MtTranslationOptions.ProviderType.MicrosoftTranslator)
{
//set mst cred
var creds2 = new GenericCredentials(dialog.Options.ClientId, dialog.Options.ClientSecret);
SetMstCredentials(credentialStore, creds2, dialog.Options.PersistMicrosoftCreds);
}
return true;
}
return false;
}
/// <summary>
/// Used for displaying the plug-in info such as the plug-in name,
/// tooltip, and icon.
/// </summary>
/// <param name="translationProviderUri"></param>
/// <param name="translationProviderState"></param>
/// <returns></returns>
public TranslationProviderDisplayInfo GetDisplayInfo(Uri translationProviderUri, string translationProviderState)
{
var info = new TranslationProviderDisplayInfo();
var options = new MtTranslationOptions(translationProviderUri);
info.TranslationProviderIcon = PluginResources.my_icon;
if (options.SelectedProvider == MtTranslationOptions.ProviderType.GoogleTranslate)
{
info.Name = PluginResources.Google_NiceName;
info.TooltipText = PluginResources.Google_Tooltip;
info.SearchResultImage = PluginResources.my_image;
}
else if (options.SelectedProvider == MtTranslationOptions.ProviderType.MicrosoftTranslator)
{
info.Name = PluginResources.Microsoft_NiceName;
info.TooltipText = PluginResources.Microsoft_Tooltip;
info.SearchResultImage = PluginResources.microsoft_image;
}
else
{
info.Name = PluginResources.Plugin_NiceName;
info.TooltipText = PluginResources.Plugin_Tooltip;
}
return info;
}
public bool SupportsTranslationProviderUri(Uri translationProviderUri)
{
if (translationProviderUri == null)
{
throw new ArgumentNullException(PluginResources.UriNotSupportedMessage);
}
return String.Equals(translationProviderUri.Scheme, MtTranslationProvider.ListTranslationProviderScheme, StringComparison.CurrentCultureIgnoreCase);
}
public string TypeDescription => PluginResources.Plugin_Description;
public string TypeName => PluginResources.Plugin_NiceName;
}
}
Generated Image Alt-Text
[edited by: RWS Community AI at 12:49 PM (GMT 0) on 27 Mar 2025]
