using System; using System.Linq; using System.Threading.Tasks; using Microsoft.EntityFrameworkCore; using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.JsonPatch; using AyaNova.Util; using AyaNova.Api.ControllerHelpers; using AyaNova.Models; using Newtonsoft.Json.Linq; using System.Collections.Generic; using System.Text.RegularExpressions; using Microsoft.Extensions.DependencyInjection; namespace AyaNova.Biz { internal class LocaleBiz : BizObject, IImportAyaNova7Object { public bool SeedOrImportRelaxedRulesMode { get; set; } internal LocaleBiz(AyContext dbcontext, long currentUserId, long userLocaleId, AuthorizationRoles userRoles) { ct = dbcontext; UserId = currentUserId; UserLocaleId = userLocaleId; CurrentUserRoles = userRoles; BizType = AyaType.Locale; SeedOrImportRelaxedRulesMode = false;//default } internal static LocaleBiz GetBiz(AyContext ct, Microsoft.AspNetCore.Http.HttpContext httpContext) { return new LocaleBiz(ct, UserIdFromContext.Id(httpContext.Items), UserLocaleIdFromContext.Id(httpContext.Items), UserRolesFromContext.Roles(httpContext.Items)); } //Version for internal use internal static LocaleBiz GetBizInternal(AyContext ct, long currentUserId, AuthorizationRoles roles) { return new LocaleBiz(ct, currentUserId, ServerBootConfig.AYANOVA_DEFAULT_LANGUAGE_ID, roles); } //////////////////////////////////////////////////////////////////////////////////////////////// //DUPLICATE - only way to create a new locale // internal async Task DuplicateAsync(NameIdItem inObj) { //make sure sourceid exists if (!await LocaleExistsAsync(inObj.Id)) AddError(ApiErrorCode.VALIDATION_INVALID_VALUE, "Id", "Source locale id does not exist"); //Ensure name is unique and not too long and not empty await ValidateAsync(inObj.Name, true); if (HasErrors) return null; //fetch the existing locale for duplication var SourceLocale = await ct.Locale.Include(x => x.LocaleItems).SingleOrDefaultAsync(m => m.Id == inObj.Id); //replicate the source to a new dest and save Locale NewLocale = new Locale(); NewLocale.Name = inObj.Name; NewLocale.Stock = false; NewLocale.CjkIndex = false; foreach (LocaleItem i in SourceLocale.LocaleItems) { NewLocale.LocaleItems.Add(new LocaleItem() { Key = i.Key, Display = i.Display }); } //Add it to the context so the controller can save it await ct.Locale.AddAsync(NewLocale); await ct.SaveChangesAsync(); //Log await EventLogProcessor.LogEventToDatabaseAsync(new Event(UserId, NewLocale.Id, AyaType.Locale, AyaEvent.Created), ct); return NewLocale; } //////////////////////////////////////////////////////////////////////////////////////////////// /// GET //Get entire locale internal async Task GetAsync(long fetchId) { //This is simple so nothing more here, but often will be copying to a different output object or some other ops return await ct.Locale.Include(x => x.LocaleItems).SingleOrDefaultAsync(m => m.Id == fetchId); } //get picklist (simple non-paged) internal async Task> GetPickListAsync() { List l = new List(); l = await ct.Locale .AsNoTracking() .OrderBy(m => m.Name) .Select(m => new NameIdItem() { Id = m.Id, Name = m.Name }).ToListAsync(); return l; } #if (DEBUG) internal async Task LocaleKeyCoverageAsync() { AyaNova.Api.Controllers.LocaleController.LocaleCoverageInfo L = new AyaNova.Api.Controllers.LocaleController.LocaleCoverageInfo(); L.RequestedKeys = ServerBootConfig.LocaleKeysRequested; L.RequestedKeys.Sort(); var AllKeys = await GetKeyListAsync(); foreach (string StockKey in AllKeys) { if (!L.RequestedKeys.Contains(StockKey)) { L.NotRequestedKeys.Add(StockKey); } } L.NotRequestedKeys.Sort(); L.RequestedKeyCount = L.RequestedKeys.Count; L.NotRequestedKeyCount = L.NotRequestedKeys.Count; return L; } //Track requests for keys so we can determine which are being used and which are not //TODO: Ideally this should be paired with tests that either directly request each key that are def. being used //or the UI needs to be tested in a way that triggers every key to be used even errors etc internal static void TrackRequestedKey(string key) { if (!ServerBootConfig.LocaleKeysRequested.Contains(key)) ServerBootConfig.LocaleKeysRequested.Add(key); } internal static void TrackRequestedKey(List keys) { foreach (string Key in keys) { if (!ServerBootConfig.LocaleKeysRequested.Contains(Key)) ServerBootConfig.LocaleKeysRequested.Add(Key); } } #endif //Get the keys for a list of keys provided internal async Task>> GetSubsetAsync(List param) { #if (DEBUG) TrackRequestedKey(param); #endif var ret = await ct.LocaleItem.Where(x => x.LocaleId == UserLocaleId && param.Contains(x.Key)).ToDictionaryAsync(x => x.Key, x => x.Display); return ret.ToList(); } //Get the keys for a list of keys provided, static format for calling from other internal classes internal static async Task> GetSubsetStaticAsync(List param, long localeId) { #if (DEBUG) TrackRequestedKey(param); #endif AyContext ct = ServiceProviderProvider.DBContext; if (!await LocaleExistsStaticAsync(localeId, ct)) localeId = ServerBootConfig.AYANOVA_DEFAULT_LANGUAGE_ID; var ret = await ct.LocaleItem.Where(x => x.LocaleId == localeId && param.Contains(x.Key)).AsNoTracking().ToDictionaryAsync(x => x.Key, x => x.Display); return ret; } //Get the CJKIndex value for the locale specified internal static async Task GetCJKIndexAsync(long localeId, AyContext ct = null) { if (ct == null) ct = ServiceProviderProvider.DBContext; var ret = await ct.Locale.Where(x => x.Id == localeId).AsNoTracking().Select(m => m.CjkIndex).SingleOrDefaultAsync(); return ret; } /// /// Get the value of the key provided in the default locale chosen /// /// /// internal static async Task GetDefaultLocalizedTextAsync(string key) { if (string.IsNullOrWhiteSpace(key)) return "ERROR: GetDefaultLocalizedText NO KEY VALUE SPECIFIED"; #if (DEBUG) TrackRequestedKey(key); #endif AyContext ct = ServiceProviderProvider.DBContext; return await ct.LocaleItem.Where(m => m.LocaleId == ServerBootConfig.AYANOVA_DEFAULT_LANGUAGE_ID && m.Key == key).Select(m => m.Display).AsNoTracking().FirstOrDefaultAsync(); } //Get all stock keys that are valid (used for import) internal static async Task> GetKeyListAsync() { AyContext ct = ServiceProviderProvider.DBContext; return await ct.LocaleItem.Where(m => m.LocaleId == 1).OrderBy(m => m.Key).Select(m => m.Key).AsNoTracking().ToListAsync(); } //////////////////////////////////////////////////////////////////////////////////////////////// //UPDATE // internal async Task PutLocaleItemDisplayTextAsync(LocaleItem dbObj, NewTextIdConcurrencyTokenItem inObj, Locale dbParent) { if (dbParent.Stock == true) { AddError(ApiErrorCode.INVALID_OPERATION, "object", "LocaleItem is from a Stock locale and cannot be modified"); return false; } //Replace the db object with the PUT object //CopyObject.Copy(inObj, dbObj, "Id"); dbObj.Display = inObj.NewText; //Set "original" value of concurrency token to input token //this will allow EF to check it out ct.Entry(dbObj).OriginalValues["ConcurrencyToken"] = inObj.ConcurrencyToken; //Only thing to validate is if it has data at all in it if (string.IsNullOrWhiteSpace(inObj.NewText)) AddError(ApiErrorCode.VALIDATION_REQUIRED, "Display (NewText)"); if (HasErrors) return false; await ct.SaveChangesAsync(); //Log await EventLogProcessor.LogEventToDatabaseAsync(new Event(UserId, dbParent.Id, AyaType.Locale, AyaEvent.Modified), ct); return true; } internal async Task PutLocaleNameAsync(Locale dbObj, NewTextIdConcurrencyTokenItem inObj) { if (dbObj.Stock == true) { AddError(ApiErrorCode.INVALID_OPERATION, "object", "Locale is a Stock locale and cannot be modified"); return false; } dbObj.Name = inObj.NewText; //Set "original" value of concurrency token to input token //this will allow EF to check it out ct.Entry(dbObj).OriginalValues["ConcurrencyToken"] = inObj.ConcurrencyToken; await ValidateAsync(dbObj.Name, false); if (HasErrors) return false; await ct.SaveChangesAsync(); //Log await EventLogProcessor.LogEventToDatabaseAsync(new Event(UserId, dbObj.Id, AyaType.Locale, AyaEvent.Modified), ct); return true; } //////////////////////////////////////////////////////////////////////////////////////////////// //DELETE // internal async Task DeleteAsync(Locale dbObj) { //Determine if the object can be deleted, do the deletion tentatively await ValidateCanDeleteAsync(dbObj); if (HasErrors) return false; ct.Locale.Remove(dbObj); await ct.SaveChangesAsync(); //Log await EventLogProcessor.DeleteObjectLogAsync(UserId, AyaType.Locale, dbObj.Id, dbObj.Name, ct); return true; } //////////////////////////////////////////////////////////////////////////////////////////////// //VALIDATION // //Can save or update? private async Task ValidateAsync(string inObjName, bool isNew) { //run validation and biz rules //Name required if (string.IsNullOrWhiteSpace(inObjName)) AddError(ApiErrorCode.VALIDATION_REQUIRED, "Name"); //Name must be less than 255 characters if (inObjName.Length > 255) AddError(ApiErrorCode.VALIDATION_LENGTH_EXCEEDED, "Name", "255 char max"); //Name must be unique if (await ct.Locale.AnyAsync(m => m.Name == inObjName)) AddError(ApiErrorCode.VALIDATION_NOT_UNIQUE, "Name"); return; } //Can delete? private async Task ValidateCanDeleteAsync(Locale inObj) { //Decided to short circuit these; if there is one issue then return immediately (fail fast rule) //Ensure it's not a stock locale if (inObj.Stock == true) { AddError(ApiErrorCode.INVALID_OPERATION, "object", "Locale is a Stock locale and cannot be deleted"); return; } if (inObj.Id == ServerBootConfig.AYANOVA_DEFAULT_LANGUAGE_ID) { AddError(ApiErrorCode.INVALID_OPERATION, "object", "Locale is set as the default server locale (AYANOVA_DEFAULT_LANGUAGE_ID) and can not be deleted"); return; } //See if any users exist with this locale selected in which case it's not deleteable if (await ct.User.AnyAsync(e => e.LocaleId == inObj.Id)) { AddError(ApiErrorCode.VALIDATION_REFERENTIAL_INTEGRITY, "object", "Can't be deleted in use by one or more Users"); return; } } //////////////////////////////////////////////////////////////////////////////////////////////// //UTILITIES // public async Task LocaleNameToIdAsync(string localeName) { var v = await ct.Locale.AsNoTracking().FirstOrDefaultAsync(c => c.Name == localeName); if (v == null) return 0; return v.Id; } public static async Task LocaleNameToIdStaticAsync(string localeName, AyContext ct = null) { if (ct == null) { ct = ServiceProviderProvider.DBContext; } var v = await ct.Locale.AsNoTracking().FirstOrDefaultAsync(c => c.Name == localeName); if (v == null) return ServerBootConfig.AYANOVA_DEFAULT_LANGUAGE_ID; return v.Id; } public async Task LocaleExistsAsync(string localeName) { return await LocaleNameToIdAsync(localeName) != 0; } public async Task LocaleExistsAsync(long id) { return await ct.Locale.AnyAsync(e => e.Id == id); } public static async Task LocaleExistsStaticAsync(long id, AyContext ct) { return await ct.Locale.AnyAsync(e => e.Id == id); } public static async Task EnsuredLocaleIdStaticAsync(long id, AyContext ct) { if (!await ct.Locale.AnyAsync(e => e.Id == id)) return ServerBootConfig.AYANOVA_DEFAULT_LANGUAGE_ID; return id; } public async Task LocaleItemExistsAsync(long id) { return await ct.LocaleItem.AnyAsync(e => e.Id == id); } /// /// Used by import, translate the old v7 locale key name into the new shorter version /// /// /// public string Translatev7LocaleKey(string oldKey) { string s = oldKey.Replace(".Label.", ".", StringComparison.InvariantCultureIgnoreCase); if (s.StartsWith("O.", StringComparison.InvariantCultureIgnoreCase)) s = s.Replace("O.", "", StringComparison.InvariantCultureIgnoreCase); s = s.Replace(".ToolBar.", ".", StringComparison.InvariantCultureIgnoreCase); s = s.Replace(".Go.", ".", StringComparison.InvariantCultureIgnoreCase); s = s.Replace(".Command.", ".", StringComparison.InvariantCultureIgnoreCase); s = s.Replace(".Error.", ".", StringComparison.InvariantCultureIgnoreCase); s = s.Replace(".Object.", ".", StringComparison.InvariantCultureIgnoreCase); if (s.StartsWith("UI.", StringComparison.InvariantCultureIgnoreCase)) s = s.Replace("UI.", "", StringComparison.InvariantCultureIgnoreCase); s = s.Replace(".", "", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("AddressAddress", "Address", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ContactPhoneContactPhone", "ContactPhone", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ContactPhonePhone", "ContactPhone", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("PurchaseOrderPurchaseOrder", "PurchaseOrder", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("WorkorderItemMiscExpenseExpense", "WorkorderItemMiscExpense", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("WorkorderItemTravelTravel", "WorkorderItemTravel", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("DashboardDashboard", "Dashboard", StringComparison.InvariantCultureIgnoreCase); //ScheduleMarkers -> Reminder s = s.Replace("ScheduleMarker", "Reminder", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerARGB", "ReminderARGB", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerColor", "ReminderColor", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerCompleted", "ReminderCompleted", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerEventCreated", "ReminderEventCreated", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerEventPendingAlert", "ReminderEventPendingAlert", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerFollowUp", "ReminderFollowUp", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerList", "ReminderList", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerName", "ReminderName", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerNotes", "ReminderNotes", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerRecurrence", "ReminderRecurrence", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerScheduleMarkerSourceType", "ReminderSourceType", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerSourceID", "ReminderSourceID", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerStartDate", "ReminderStartDate", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleMarkerStopDate", "ReminderStopDate", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleEditScheduleMarker", "ScheduleEditReminder", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("ScheduleNewScheduleMarker", "ScheduleNewReminder", StringComparison.InvariantCultureIgnoreCase); //FUTURE // s = s.Replace("WASXXX", "NOWXXXX", StringComparison.InvariantCultureIgnoreCase); // s = s.Replace("WASXXX", "NOWXXXX", StringComparison.InvariantCultureIgnoreCase); // s = s.Replace("WASXXX", "NOWXXXX", StringComparison.InvariantCultureIgnoreCase); // s = s.Replace("WASXXX", "NOWXXXX", StringComparison.InvariantCultureIgnoreCase); // s = s.Replace("WASXXX", "NOWXXXX", StringComparison.InvariantCultureIgnoreCase); //Custom fields were 0 to 9, now 1 to 16 s = s.Replace("Custom9", "Custom10", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("Custom8", "Custom9", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("Custom7", "Custom8", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("Custom6", "Custom7", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("Custom5", "Custom6", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("Custom4", "Custom5", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("Custom3", "Custom4", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("Custom2", "Custom3", StringComparison.InvariantCultureIgnoreCase); if (!s.EndsWith("Custom10")) s = s.Replace("Custom1", "Custom2", StringComparison.InvariantCultureIgnoreCase); s = s.Replace("Custom0", "Custom1", StringComparison.InvariantCultureIgnoreCase); //separate code will handle adding the new keys that didn't exist in v7 (custom 11 - 16) //CommonActive CommonID etc remove Common s = s.Replace("Common", ""); return s; } //LocaleBiz::ImportV7 - old Key "Locale.Label.UI.DestLocale" translates to new Key "LocaleDestLocale" which is not valid! //LocaleUIDestLocale /// /// Ensure stock locales and setup defaults /// Called by boot preflight check code AFTER it has already ensured the locale is a two letter code if stock one was chosen /// public async Task ValidateLocalesAsync() { //Ensure default locales are present and that there is a server default locale that exists if (!await LocaleExistsAsync("en")) { throw new System.Exception($"E1015: stock locale English (en) not found in database!"); } if (!await LocaleExistsAsync("es")) { throw new System.Exception($"E1015: stock locale Spanish (es) not found in database!"); } if (!await LocaleExistsAsync("de")) { throw new System.Exception($"E1015: stock locale German (de) not found in database!"); } if (!await LocaleExistsAsync("fr")) { throw new System.Exception($"E1015: stock locale French (fr) not found in database!"); } //Ensure chosen default locale exists switch (ServerBootConfig.AYANOVA_DEFAULT_LANGUAGE) { case "en": case "es": case "de": case "fr": break; default: if (!await LocaleExistsAsync(ServerBootConfig.AYANOVA_DEFAULT_LANGUAGE)) { throw new System.Exception($"E1015: stock locale {ServerBootConfig.AYANOVA_DEFAULT_LANGUAGE} not found in database!"); } break; } //Put the default locale ID number into the ServerBootConfig for later use ServerBootConfig.AYANOVA_DEFAULT_LANGUAGE_ID = await LocaleNameToIdAsync(ServerBootConfig.AYANOVA_DEFAULT_LANGUAGE); } ///////////////////////////////////////////////////////////////////// /// IMPORT v7 implementation public async Task ImportV7Async( JObject j, List importMap, Guid jobId, Dictionary> tagLists) { //some types need to import from more than one source hence the seemingly redundant switch statement for futureproofing switch (j["IMPORT_TASK"].Value()) { case "main": { //Get source locale name from filename using regex var SourceLocaleFileName = j["V7_SOURCE_FILE_NAME"].Value(); Regex RxExtractLocaleName = new Regex(@"locale\.(.*)\.json"); var v = RxExtractLocaleName.Match(SourceLocaleFileName); var SourceLocaleName = v.Groups[1].ToString(); //Ensure doesn't already exist if (await LocaleExistsAsync(SourceLocaleName)) { //If there are any validation errors, log in joblog and move on JobsBiz.LogJobAsync(jobId, $"LocaleBiz::ImportV7Async -> - Locale \"{SourceLocaleName}\" already exists in database, can not import over an existing locale", ct); return false; } //keys to skip importing List SkipKeys = new List(); SkipKeys.Add("UI.Label.CurrentUserName"); SkipKeys.Add("V7_SOURCE_FILE_NAME"); SkipKeys.Add("V7_TYPE"); SkipKeys.Add("IMPORT_TASK"); List ValidKeys = await GetKeyListAsync(); Dictionary NewLocaleDict = new Dictionary(); foreach (var Pair in j.Children()) { var V7Value = Pair.First.Value().Replace(" && ", " ").Replace(" & ", " ").Replace("&", "");//clean out LT values that had double ampersands for old Windows menu shortcut scheme var V7KeyName = ((JProperty)Pair).Name; if (!SkipKeys.Contains(V7KeyName)) { var RavenKeyName = Translatev7LocaleKey(V7KeyName); if (!ValidKeys.Contains(RavenKeyName)) { throw new System.ArgumentOutOfRangeException($"LocaleBiz::ImportV7 - old Key \"{V7KeyName}\" translates to new Key \"{RavenKeyName}\" which is not valid!"); } if (!NewLocaleDict.ContainsKey(RavenKeyName)) { NewLocaleDict.Add(RavenKeyName, V7Value); } else { //Use the shortest V7Value string in the case of dupes if (NewLocaleDict[RavenKeyName].Length > V7Value.Length) { NewLocaleDict[RavenKeyName] = V7Value; } } } } //Now add keys that were added after v7 for RAVEN using default locale values foreach (string s in ValidKeys) { if (!NewLocaleDict.ContainsKey(s)) { NewLocaleDict.Add(s, await GetDefaultLocalizedTextAsync(s)); } } //Validate it's the correct number of keys expected if (NewLocaleDict.Count != ValidKeys.Count) { throw new System.ArgumentOutOfRangeException($"LocaleBiz::ImportV7 - Import locale \"{SourceLocaleName}\" has an unexpected number of keys: {NewLocaleDict.Count}, expected {ValidKeys.Count} "); } //have file name, have all localized text Locale l = new Locale(); l.Name = SourceLocaleName; l.Stock = false; foreach (KeyValuePair K in NewLocaleDict) { l.LocaleItems.Add(new LocaleItem() { Key = K.Key, Display = K.Value }); } await ct.Locale.AddAsync(l); await ct.SaveChangesAsync(); //Log now that we have the Id, note that there is no source created / modified for this so just attributing to current userId await EventLogProcessor.LogEventToDatabaseAsync(new Event(UserId, l.Id, AyaType.Locale, AyaEvent.Created), ct); } break; } //this is the equivalent of returning void for a Task signature with nothing to return return true; } ///////////////////////////////////////////////////////////////////// }//eoc // }//eons