Blog posts by Dac Thach Nguyen2019-02-20T04:05:42.0000000Zhttps://world.optimizely.com/blogs/dac-thach-nguyen/Optimizely WorldCustom validation message for Forms<p>In Forms 4.23 we have released a feature that allows user can enter a custom validation message for each validator. Let say that you have some forms which used the same some validators (ex: RequiredValidator). When visitor enter something not correct, by default the form will display message stored in xml lang files. And there's no way to custom that message for different elements in different forms. But now it is easily done by editor.</p>
<p><strong>First go to edit the field and enter the message on textbox next to it:</strong></p>
<p><img src="/link/85ee6aa66c234050b5fa435ac6ba5637.aspx" /></p>
<p><strong>Publish the element, form and go to view mode to see the result:</strong></p>
<p><img src="/link/c2db503640d343bead5161acf10e05a9.aspx" /></p>
<p>That is, it's simple, right?</p>2019-02-20T04:05:42.0000000ZBlog postEPiServer Forms: How to render Forms in a dialog<p>In some real scenarios, we might need render an EPiServer Forms within a dialog instead of a page. This case will make user focus on the Form. Today I have tried to make the Form work with jQuery UI dialog. Here a some point I summarized to make it works (assume that you are working with Alloy solution).</p>
<p><strong>Create a page type to render an ContentArea with a Form</strong></p>
<pre class="language-csharp"><code>[SiteContentType(GroupName = Global.GroupNames.News, GUID = "E5CCD734-81F2-4242-82BA-8D888504112B")]
public class SubcriblePage: SitePageData
{
[Display(GroupName = SystemTabNames.Content, Order = 320)]
public virtual ContentArea MainContentArea { get; set; }
}</code></pre>
<p>Then create a page with the page type then dnd a Form into it, publish it (let say it url is: "<strong>/en/subcrible/</strong>".)</p>
<p><strong>Create a zaror layout to render a page which display nothing but Forms (</strong>_Empty.cshtml<strong>):</strong></p>
<pre class="language-markup"><code>@using System.Web.Optimization
@using EPiServer.Framework.Web.Mvc.Html
@model IPageViewModel<SitePageData>
<!DOCTYPE html>
<html lang="@Model.CurrentPage.LanguageBranch">
<head>
@Styles.Render("~/bundles/css")
@Scripts.Render("~/bundles/js")
@Html.RequiredClientResources("Header")
</head>
<body>
@RenderBody()
@Html.RequiredClientResources("Footer")
</body>
</html>
</code></pre>
<p><strong>Create a view to render for the page type (SubcriblePage)</strong></p>
<pre class="language-markup"><code>@{ Layout = "~/Views/Shared/Layouts/_Empty.cshtml"; }
@using ILMTest
@model PageViewModel<SubcriblePage>
@Html.PropertyFor(x => x.CurrentPage.MainContentArea, new { })
<script>
if (typeof $$epiforms !== 'undefined') {
$$epiforms(document).ready(function myfunction() {
$$epiforms(".EPiServerForms").on("formsSubmitted", function (event, param1, param2) {
window.parent.$(window.parent.document.body).trigger("submitted");
});
});
}
</script>
</code></pre>
<p>This razor view will render an ContentArea with the Form. Add the script will notify parent window to know when the form already submitted (we will close the dialog then).</p>
<p><strong>Open the dialog with a Form (Using iframe which loaded the page alread created above)</strong></p>
<pre class="language-markup"><code><script type="text/javascript">
var page = "/en/subcrible/";
var $dialog = $('<div></div>')
.html('<iframe style="border: 0px; overflow: hidden;" src="' + page + '" width="100%" height="100%"></iframe>')
.dialog({
autoOpen: false,
modal: true,
height: 450,
width: 500,
title: "Some title"
});
$dialog.dialog('open');
$(document).on("submitted", "body", function () {
setTimeout(function () {
$dialog.dialog("close");
}, 1000)
});
</script></code></pre>
<p>And here is result:</p>
<p><img src="https://imgur.com/a/E2UVHGD" alt="" /><img src="https://i.imgur.com/9LgGO1k.gif" alt="" /></p>2018-12-25T09:04:04.0000000ZBlog postLanguage Manager: Replace Content with Unpublished Version<p>When using Language Manager (LM) to duplicate content from other language. It always get content from Published or Common Draft version. There is a customer they want to get content from Ready To Publish version instead. To change the behavior we can intercept the <span>LanguageBranchManager service. In IConfigurableModule you add following line:</span></p>
<pre class="language-csharp"><code>public void ConfigureContainer(ServiceConfigurationContext context)
{
context.Services.Intercept<ILanguageBranchManager>((locator, defaultManager) => new MyLanguageBranchManager(defaultManager));
}</code></pre>
<p><span>And implment the MyLanguageBranchManager, most of methods we should forward to original service to process. We just modify the [CopyDataFromMasterBranch] method for copying content from Ready To Publish version instead of Published/CommonDraft one. Below is the code for doing this:</span></p>
<pre class="language-csharp"><code>public bool CopyDataFromMasterBranch(ContentReference contentReference, string fromLanguageID, string toLanguageID, Func<object, object> transformOnCopyingValue, out ContentReference createdContentLink, bool autoPublish = false)
{
fromLanguageID = fromLanguageID.Trim();
toLanguageID = toLanguageID.Trim();
createdContentLink = null;
// get ReadyToPublish version here to process copying, fallback to Published or CommonDraft version
var masterContent = GetReadyForPublishVersion(contentReference, fromLanguageID) ?? GetPublishedOrCommonDraftVersion(contentReference, fromLanguageID);
var destContent = GetPublishedOrCommonDraftVersion(contentReference, toLanguageID);
if (masterContent == null)
{
throw new ContentNotFoundException(contentReference);
}
if (destContent == null)
{
CreateLanguageBranch(contentReference, toLanguageID, out createdContentLink);
}
var createdDestContent = contentRepository.Service.Get<IContent>(contentReference.ToReferenceWithoutVersion(), new LanguageSelector(toLanguageID));
createdDestContent = (createdDestContent as IReadOnly).CreateWritableClone() as IContent;
#region process for Name, PageURLSegment property of both page and block
if (transformOnCopyingValue == null)
{
createdDestContent.Name = masterContent.Name;
}
else
{
createdDestContent.Name = transformOnCopyingValue(masterContent.Name) as string;
if (masterContent.Property["PageURLSegment"] != null)
{
string url = transformOnCopyingValue(masterContent.Property["PageURLSegment"].ToWebString().Replace('-', ' ')) as string; /* the result from Bing */
url = Regex.Replace(url, @"\s+", " ", RegexOptions.IgnoreCase | RegexOptions.Compiled | RegexOptions.CultureInvariant).Trim(); // convert multiple spaces into one space
url = Regex.Replace(url, @"\s", "-", RegexOptions.IgnoreCase | RegexOptions.Compiled | RegexOptions.CultureInvariant); // Replace spaces by dashes
url = Regex.Replace(url, @"[^a-z0-9~_\-\.]", matchEvaluatorRandomReplace, RegexOptions.IgnoreCase | RegexOptions.Compiled | RegexOptions.CultureInvariant); // Remove all non valid chars
createdDestContent.Property["PageURLSegment"].Value = url;
}
}
#endregion
#region process all LanguageSpecific, non-meta, editable properties
foreach (PropertyData destProp in createdDestContent.Property.Where(pd =>
(pd.IsLanguageSpecific && !pd.IsMetaData && !pd.IsReadOnly) // find all non-metadata properties, which is editable, language specific
))
{
var nestedContentData = destProp.Value as IContentData; // block
if (null != nestedContentData) // if is block, ...
{
CopyDataForNestedContentRecursive(masterContent.Property[destProp.Name] as IContentData, nestedContentData, transformOnCopyingValue);
}
else
{
// some data type and its property type (e.g. CategoryList & PropertyCategory) implements IModifiedTrackable and then a call to IsModified
// (leading to IReadOnly.ThrowIfReadOnly) from ContentRepository.Save below, so that must use WritableClone value
var srcPropValue = masterContent.Property[destProp.Name].Value;
destProp.Value = srcPropValue is IReadOnly ? ((IReadOnly)srcPropValue).CreateWritableClone() : srcPropValue;
if (transformOnCopyingValue != null && destProp.Value != null)
{
var translatedText = transformOnCopyingValue(destProp);
TryToAssignStringToProperty(translatedText, destProp);
}
}
} // end foreach prop in page level
#endregion
// skip validation, because translate might be failed sometime.
var saveFlag = SaveAction.Save | SaveAction.SkipValidation;
saveFlag = (createdDestContent as IVersionable).Status == VersionStatus.Published ?
saveFlag | SaveAction.ForceNewVersion : saveFlag | SaveAction.ForceCurrentVersion;
if (autoPublish)
{
saveFlag = saveFlag | SaveAction.Publish;
}
createdContentLink = contentRepository.Service.Save(createdDestContent, saveFlag, AccessLevel.NoAccess);
contentVersionRepository.Service.SetCommonDraft(createdContentLink);
return true;
// return _defaultLanguageBranchManager.CopyDataFromMasterBranch(contentReference, fromLanguageID, toLanguageID, transformOnCopyingValue, out createdContentLink, autoPublish);
}
private IContent GetReadyForPublishVersion(ContentReference contentLink, string languageID)
{
var contentVersionRepository = ServiceLocator.Current.GetInstance<IContentVersionRepository>();
var versions = contentVersionRepository.List(contentLink, languageID);
var readyToPublishVersion = versions.FirstOrDefault(v => v.Status == VersionStatus.CheckedIn);
var contentRepository = ServiceLocator.Current.GetInstance<IContentRepository>();
if (readyToPublishVersion != null)
{
return contentRepository.Get<IContent>(readyToPublishVersion.ContentLink);
}
return null;
}
/// <summary>
/// Copies the data for nested content recursively.
/// </summary>
/// <param name="sourceContentData">The source content data.</param>
/// <param name="targetContentData">The target content data.</param>
/// <param name="transformOnCopyingValue">perform a transformation on copying property's value</param>
private void CopyDataForNestedContentRecursive(IContentData sourceContentData, IContentData targetContentData, Func<object, object> transformOnCopyingValue)
{
using (IEnumerator<PropertyData> propertyDataEnumerator = targetContentData.Property
.Where(pd => pd.IsLanguageSpecific && !pd.IsMetaData && !pd.IsReadOnly)
.GetEnumerator())
{
while (propertyDataEnumerator.MoveNext())
{
var targetProp = propertyDataEnumerator.Current;
if (targetProp is IContentData)
{
CopyDataForNestedContentRecursive(sourceContentData.Property[targetProp.Name] as IContentData, targetProp as IContentData, transformOnCopyingValue);
}
else
{
// some data type and its property type (e.g. CategoryList & PropertyCategory) implements IModifiedTrackable and then a call to IsModified
// (leading to IReadOnly.ThrowIfReadOnly) from ContentRepository.Save below, so that must use WritableClone value
var srcPropValue = sourceContentData.Property[targetProp.Name].Value;
targetProp.Value = srcPropValue is IReadOnly ? ((IReadOnly)srcPropValue).CreateWritableClone() : srcPropValue;
if (transformOnCopyingValue != null)
{
var translatedText = transformOnCopyingValue(targetProp);
TryToAssignStringToProperty(translatedText, targetProp);
}
}
}
}
}
/// <summary>
/// assign <paramref name="obj"/> to <paramref name="prop"/> might lead to exception because <paramref name="prop"/> cannot accept string >255.
/// We try to shorten it before assigning again.
/// </summary>
/// <param name="obj"></param>
/// <param name="prop"></param>
/// <returns></returns>
private void TryToAssignStringToProperty(object obj, PropertyData prop)
{
try
{
prop.Value = obj;
}
catch (EPiServerException ex)
{
if (ex.Message.Contains("exceeded")) // exceeded 255 characters
{
prop.Value = ((string)obj).Substring(0, 255);
}
else
{
throw;
}
}
}</code></pre>
<p>If you have similar requirement for your site. I hope this will help you a litle bit.</p>2018-10-30T08:07:15.0000000ZBlog postLanguage Manager: Receive email notification when import translation package success<!DOCTYPE html>
<html>
<head>
</head>
<body>
<p>When import a translation package using Language add-on, the project owner will be notified after the package is proccessed. The notification will be display on the bell which is on top of edit view. That required you to login into the system to know. The add-on allowed you to write your own notification provider which send notification in other channels.</p>
<p>In order to write custom provider you need to implement INotificationProvider which has method and property as below:</p>
<p><strong>DisplayName: </strong>Name of the provider, example "Email Notification"<br /><strong>SetNotification: </strong>Method will be called after the import proccess has been finished.</p>
<p>After implement that interface, your notification provider will be display in config page of the add-on. See the image:<img src="/link/39259a89e41f4f4999acbea2d8e09813.aspx" alt="Image language.png" /></p>
<p>Here is simple on I have implement, after config it in the admin page. You should receive email whenever a translation project imported.</p>
<pre class="language-csharp"><code>public class EmailNotification : INotificationProvider
{
public string DisplayName => "Email Notification";
public void SetNotification(string userName, string message)
{
var mail = new MailMessage();
mail.Subject = "Project has been translated successfully";
mail.Body = message;
mail.From = new MailAddress("<your email>@gmail.com");
mail.To.Add(new MailAddress("<your email>@gmail.com"));
var smtpClient = new SmtpClient();
smtpClient.Send(mail);
}
}</code></pre>
</body>
</html>2018-07-31T06:21:47.0000000ZBlog post