/// <summary> Builds the complete web skin object </summary>
/// <param name="Skin_Row"> Row for this web skin, from the database query </param>
/// <param name="Tracer"></param>
/// <returns> Complete web skin </returns>
public static Complete_Web_Skin_Object Build_Skin_Complete(DataRow Skin_Row, Custom_Tracer Tracer)
{
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin_Complete", "Building the complete web skin from the row and design files");
}
// Pull values out from this row
string code = Skin_Row["WebSkinCode"].ToString();
string base_interface = Skin_Row["BaseInterface"].ToString();
bool override_banner = Convert.ToBoolean(Skin_Row["OverrideBanner"]);
string banner_link = Skin_Row["BannerLink"].ToString();
string notes = Skin_Row["Notes"].ToString();
string this_style = code + ".css";
string this_javascript = code + ".js";
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin_Complete", "Verifying existence of the CSS file");
}
string style_file = Path.Combine(Engine_ApplicationCache_Gateway.Settings.Servers.Base_Design_Location, "skins", code, this_style);
if (!File.Exists(style_file))
{
this_style = String.Empty;
}
string javascript_file = Path.Combine(Engine_ApplicationCache_Gateway.Settings.Servers.Base_Design_Location, "skins", code, this_javascript);
if (!File.Exists(javascript_file))
{
this_javascript = String.Empty;
}
// Create the web skin object
Complete_Web_Skin_Object completeSkin = new Complete_Web_Skin_Object(code, this_style)
{
Override_Banner = override_banner,
Suppress_Top_Navigation = Convert.ToBoolean(Skin_Row["SuppressTopNavigation"]),
Notes = notes,
Javascript_File = this_javascript
};
// Assign the optional values
if (!String.IsNullOrEmpty(base_interface))
{
completeSkin.Base_Skin_Code = base_interface;
}
if (!String.IsNullOrEmpty(banner_link))
{
completeSkin.Banner_Link = banner_link;
}
// Look for source files
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin_Complete", "Look for all the source files in the design folder");
}
string html_soure_directory = Path.Combine(Engine_ApplicationCache_Gateway.Settings.Servers.Base_Design_Location, "skins", code, "html");
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin_Complete", "Design folder = " + html_soure_directory);
}
try
{
if (Directory.Exists(html_soure_directory))
{
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin_Complete", "Building the dictionary of language-specific headers and footers");
}
string[] possible_header_files = Directory.GetFiles(html_soure_directory, "*.htm*");
foreach (string thisHeaderFile in possible_header_files)
{
// Get the filename
string fileName = Path.GetFileName(thisHeaderFile);
// Should not ever really be null, but if so. just skip it
if (String.IsNullOrEmpty(fileName))
{
continue;
}
// Was this an item header file?
if (fileName.IndexOf("header_item", StringComparison.InvariantCultureIgnoreCase) == 0)
{
// If this is default (with no language specified) add as DEFAULT
if (fileName.ToLower().Contains("header_item.htm"))
{
if (completeSkin.SourceFiles.ContainsKey(Web_Language_Enum.DEFAULT))
{
completeSkin.SourceFiles[Web_Language_Enum.DEFAULT].Header_Item_Source_File = Path.Combine("html", fileName);
}
else
{
Complete_Web_Skin_Source_Files sourceFiles = new Complete_Web_Skin_Source_Files {
Header_Item_Source_File = Path.Combine("html", fileName)
};
completeSkin.SourceFiles[Web_Language_Enum.DEFAULT] = sourceFiles;
}
}
else
{
// Look for and parse the language code in the file
string[] parsed = fileName.Split("_-.".ToCharArray());
if (parsed.Length == 4)
{
Web_Language_Enum languageEnum = Web_Language_Enum_Converter.Code_To_Enum(parsed[2]);
if (languageEnum != Web_Language_Enum.UNDEFINED)
{
if (completeSkin.SourceFiles.ContainsKey(languageEnum))
{
completeSkin.SourceFiles[languageEnum].Header_Item_Source_File = Path.Combine("html", fileName);
}
else
{
Complete_Web_Skin_Source_Files sourceFiles = new Complete_Web_Skin_Source_Files {
Header_Item_Source_File = Path.Combine("html", fileName)
};
completeSkin.SourceFiles[languageEnum] = sourceFiles;
}
}
}
}
}
// Was this a non-item header file?
else if (fileName.IndexOf("header", StringComparison.InvariantCultureIgnoreCase) == 0)
{
// If this is default (with no language specified) add as DEFAULT
if (fileName.ToLower().Contains("header.htm"))
{
if (completeSkin.SourceFiles.ContainsKey(Web_Language_Enum.DEFAULT))
{
completeSkin.SourceFiles[Web_Language_Enum.DEFAULT].Header_Source_File = Path.Combine("html", fileName);
}
else
{
Complete_Web_Skin_Source_Files sourceFiles = new Complete_Web_Skin_Source_Files {
Header_Source_File = Path.Combine("html", fileName)
};
completeSkin.SourceFiles[Web_Language_Enum.DEFAULT] = sourceFiles;
}
}
else
{
// Look for and parse the language code in the file
string[] parsed = fileName.Split("_-.".ToCharArray());
if (parsed.Length == 3)
{
Web_Language_Enum languageEnum = Web_Language_Enum_Converter.Code_To_Enum(parsed[1]);
if (languageEnum != Web_Language_Enum.UNDEFINED)
{
if (completeSkin.SourceFiles.ContainsKey(languageEnum))
{
completeSkin.SourceFiles[languageEnum].Header_Source_File = Path.Combine("html", fileName);
}
else
{
Complete_Web_Skin_Source_Files sourceFiles = new Complete_Web_Skin_Source_Files {
Header_Source_File = Path.Combine("html", fileName)
};
completeSkin.SourceFiles[languageEnum] = sourceFiles;
}
}
}
}
}
// Was this a item footer file?
else if (fileName.IndexOf("footer_item", StringComparison.InvariantCultureIgnoreCase) == 0)
{
// If this is default (with no language specified) add as DEFAULT
if (fileName.ToLower().Contains("footer_item.htm"))
{
if (completeSkin.SourceFiles.ContainsKey(Web_Language_Enum.DEFAULT))
{
completeSkin.SourceFiles[Web_Language_Enum.DEFAULT].Footer_Item_Source_File = Path.Combine("html", fileName);
}
else
{
Complete_Web_Skin_Source_Files sourceFiles = new Complete_Web_Skin_Source_Files {
Footer_Item_Source_File = Path.Combine("html", fileName)
};
completeSkin.SourceFiles[Web_Language_Enum.DEFAULT] = sourceFiles;
}
}
else
{
// Look for and parse the language code in the file
string[] parsed = fileName.Split("_-.".ToCharArray());
if (parsed.Length == 4)
{
Web_Language_Enum languageEnum = Web_Language_Enum_Converter.Code_To_Enum(parsed[2]);
if (languageEnum != Web_Language_Enum.UNDEFINED)
{
if (completeSkin.SourceFiles.ContainsKey(languageEnum))
{
completeSkin.SourceFiles[languageEnum].Footer_Item_Source_File = Path.Combine("html", fileName);
}
else
{
Complete_Web_Skin_Source_Files sourceFiles = new Complete_Web_Skin_Source_Files {
Footer_Item_Source_File = Path.Combine("html", fileName)
};
completeSkin.SourceFiles[languageEnum] = sourceFiles;
}
}
}
}
}
// Was this a non-item footer file?
else if (fileName.IndexOf("footer", StringComparison.InvariantCultureIgnoreCase) == 0)
{
// If this is default (with no language specified) add as DEFAULT
if (fileName.ToLower().Contains("footer.htm"))
{
if (completeSkin.SourceFiles.ContainsKey(Web_Language_Enum.DEFAULT))
{
completeSkin.SourceFiles[Web_Language_Enum.DEFAULT].Footer_Item_Source_File = Path.Combine("html", fileName);
}
else
{
Complete_Web_Skin_Source_Files sourceFiles = new Complete_Web_Skin_Source_Files {
Footer_Source_File = Path.Combine("html", fileName)
};
completeSkin.SourceFiles[Web_Language_Enum.DEFAULT] = sourceFiles;
}
}
else
{
// Look for and parse the language code in the file
string[] parsed = fileName.Split("_-.".ToCharArray());
if (parsed.Length == 3)
{
Web_Language_Enum languageEnum = Web_Language_Enum_Converter.Code_To_Enum(parsed[1]);
if (languageEnum != Web_Language_Enum.UNDEFINED)
{
if (completeSkin.SourceFiles.ContainsKey(languageEnum))
{
completeSkin.SourceFiles[languageEnum].Footer_Source_File = Path.Combine("html", fileName);
}
else
{
Complete_Web_Skin_Source_Files sourceFiles = new Complete_Web_Skin_Source_Files {
Footer_Source_File = Path.Combine("html", fileName)
};
completeSkin.SourceFiles[languageEnum] = sourceFiles;
}
}
}
}
}
}
}
else
{
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin_Complete", "Unable to find the design folder ( '" + html_soure_directory + "')");
}
completeSkin.Exception = "Unable to find the design folder ( '" + html_soure_directory + "')";
}
}
catch (Exception ee)
{
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin_Complete", "Exception encountered while checking for web skin source files: " + ee.Message);
}
completeSkin.Exception = "Exception encountered while checking for web skin source files: " + ee.Message;
}
// Look for banners as well
if (override_banner)
{
try
{
string banner_source_directory = Path.Combine(Engine_ApplicationCache_Gateway.Settings.Servers.Base_Design_Location, "skins", code);
if (Directory.Exists(banner_source_directory))
{
string[] possible_banner_files = Directory.GetFiles(banner_source_directory, "banner*.*");
foreach (string thisBannerFile in possible_banner_files)
{
// Get the filename
string fileName = Path.GetFileName(thisBannerFile);
// If this is default (with no language specified) add as DEFAULT
if (fileName.ToLower().Contains("banner."))
{
if (completeSkin.SourceFiles.ContainsKey(Web_Language_Enum.DEFAULT))
{
completeSkin.SourceFiles[Web_Language_Enum.DEFAULT].Banner = fileName;
}
else
{
Complete_Web_Skin_Source_Files sourceFiles = new Complete_Web_Skin_Source_Files {
Banner = fileName
};
completeSkin.SourceFiles[Web_Language_Enum.DEFAULT] = sourceFiles;
}
}
else
{
// Look for and parse the language code in the file
string[] parsed = fileName.Split("_-.".ToCharArray());
if (parsed.Length == 3)
{
Web_Language_Enum languageEnum = Web_Language_Enum_Converter.Code_To_Enum(parsed[1]);
if (languageEnum != Web_Language_Enum.UNDEFINED)
{
if (completeSkin.SourceFiles.ContainsKey(languageEnum))
{
completeSkin.SourceFiles[languageEnum].Banner = fileName;
}
else
{
Complete_Web_Skin_Source_Files sourceFiles = new Complete_Web_Skin_Source_Files {
Banner = fileName
};
completeSkin.SourceFiles[languageEnum] = sourceFiles;
}
}
}
}
}
}
}
catch (Exception ee)
{
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin_Complete", "Exception encountered while checking for web skin banner: " + ee.Message);
}
completeSkin.Exception = "Exception encountered while checking for web skin banner: " + ee.Message;
}
}
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin_Complete", "Return the built complete web skin");
}
return(completeSkin);
}
/// <summary> Builds a language-specific <see cref="Web_Skin_Object"/> when needed by a user's request </summary>
/// <param name="CompleteSkin"> Complete web skin object </param>
/// <param name="Language_Code"> Code for the language, which determines which HTML to use </param>
/// <param name="Tracer"></param>
/// <returns> Completely built HTML interface object </returns>
/// <remarks> The datarow for this method is retrieved from the database by calling the <see cref="Database.Engine_Database.Get_All_Web_Skins"/> method during
/// application startup and is then stored in the <see cref="Web_Skin_Collection"/> class until needed. </remarks>
public static Web_Skin_Object Build_Skin(Complete_Web_Skin_Object CompleteSkin, string Language_Code, Custom_Tracer Tracer)
{
// Look for the language
Web_Language_Enum language = Web_Language_Enum_Converter.Code_To_Enum(Language_Code);
Web_Language_Enum original_language = language;
if (!CompleteSkin.SourceFiles.ContainsKey(language))
{
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Language requested ( " + Web_Language_Enum_Converter.Enum_To_Name(language) + " ) not in language list");
}
language = Engine_ApplicationCache_Gateway.Settings.System.Default_UI_Language;
if ((original_language == language) || (!CompleteSkin.SourceFiles.ContainsKey(language)))
{
if ((Tracer != null) && (original_language != language))
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Default UI language ( " + Web_Language_Enum_Converter.Enum_To_Name(language) + " ) not in language list");
}
language = Web_Language_Enum.DEFAULT;
if (!CompleteSkin.SourceFiles.ContainsKey(language))
{
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "DEFAULT language not in language list");
}
language = Web_Language_Enum.English;
if (!CompleteSkin.SourceFiles.ContainsKey(language))
{
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "English language also not in language list");
}
if (CompleteSkin.SourceFiles.Count > 0)
{
language = CompleteSkin.SourceFiles.Keys.First();
}
else
{
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Apparently there are NO source files.. returning NULL");
}
language = Web_Language_Enum.UNDEFINED;
}
}
}
}
}
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Will build language-specific web skin for '" + Web_Language_Enum_Converter.Enum_To_Name(language) + "'");
}
// Now, look in the cache for this
if (language != Web_Language_Enum.UNDEFINED)
{
Web_Skin_Object cacheObject = CachedDataManager.WebSkins.Retrieve_Skin(CompleteSkin.Skin_Code, Web_Language_Enum_Converter.Enum_To_Code(language), null);
if (cacheObject != null)
{
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Web skin found in the memory cache");
}
return(cacheObject);
}
}
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Web skin not found in the memory cache, so building it now");
}
// Build this then
Web_Skin_Object returnValue = new Web_Skin_Object(CompleteSkin.Skin_Code, CompleteSkin.Base_Skin_Code);
if (!String.IsNullOrEmpty(CompleteSkin.CSS_Style))
{
returnValue.CSS_Style = "design/skins/" + CompleteSkin.Skin_Code + "/" + CompleteSkin.CSS_Style;
}
if (!String.IsNullOrEmpty(CompleteSkin.Javascript_File))
{
returnValue.Javascript = "design/skins/" + CompleteSkin.Skin_Code + "/" + CompleteSkin.Javascript_File;
}
// Set the language code
if (language == Web_Language_Enum.DEFAULT)
{
returnValue.Language_Code = Web_Language_Enum_Converter.Enum_To_Code(Engine_ApplicationCache_Gateway.Settings.System.Default_UI_Language);
}
else if (language == Web_Language_Enum.UNDEFINED)
{
returnValue.Language_Code = Web_Language_Enum_Converter.Enum_To_Code(language);
}
// Set some optional (nullable) flags
if (CompleteSkin.Override_Banner)
{
returnValue.Override_Banner = true;
}
if (CompleteSkin.Suppress_Top_Navigation)
{
returnValue.Suppress_Top_Navigation = true;
}
// If no suitable language was found, probably an error (no source files at all)
if (language == Web_Language_Enum.UNDEFINED)
{
if (!String.IsNullOrEmpty(CompleteSkin.Exception))
{
returnValue.Exception = CompleteSkin.Exception;
}
else
{
returnValue.Exception = "No valid source files found";
}
// Also set the headers and footers to the exception
returnValue.Header_HTML = returnValue.Exception;
returnValue.Footer_HTML = returnValue.Exception;
returnValue.Header_Item_HTML = returnValue.Exception;
returnValue.Footer_Item_HTML = returnValue.Exception;
return(returnValue);
}
// Get the source file
Complete_Web_Skin_Source_Files sourceFiles = CompleteSkin.SourceFiles[language];
// Build the banner
if ((returnValue.Override_Banner.HasValue) && (returnValue.Override_Banner.Value))
{
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Skin overrides the banner, so build the banner HTML");
}
// Find the LANGUAGE-SPECIFIC high-bandwidth banner image
if (!String.IsNullOrEmpty(sourceFiles.Banner))
{
if (!String.IsNullOrEmpty(CompleteSkin.Banner_Link))
{
returnValue.Banner_HTML = "<a href=\"" + CompleteSkin.Banner_Link + "\"><img border=\"0\" src=\"<%BASEURL%>skins/" + CompleteSkin.Skin_Code + "/" + sourceFiles.Banner + "\" alt=\"MISSING BANNER\" /></a>";
}
else
{
returnValue.Banner_HTML = "<img border=\"0\" src=\"<%BASEURL%>skins/" + CompleteSkin.Skin_Code + "/" + sourceFiles.Banner + "\" alt=\"MISSING BANNER\" />";
}
}
}
// Now, set the header and footer html
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Determine the header footer source HTML files");
}
string this_header = Path.Combine(Engine_ApplicationCache_Gateway.Settings.Servers.Base_Design_Location, "skins", CompleteSkin.Skin_Code, sourceFiles.Header_Source_File);
string this_footer = Path.Combine(Engine_ApplicationCache_Gateway.Settings.Servers.Base_Design_Location, "skins", CompleteSkin.Skin_Code, sourceFiles.Footer_Source_File);
string this_item_header = Path.Combine(Engine_ApplicationCache_Gateway.Settings.Servers.Base_Design_Location, "skins", CompleteSkin.Skin_Code, sourceFiles.Header_Item_Source_File);
string this_item_footer = Path.Combine(Engine_ApplicationCache_Gateway.Settings.Servers.Base_Design_Location, "skins", CompleteSkin.Skin_Code, sourceFiles.Footer_Item_Source_File);
// If the item specific stuff doesn't exist, use the regular
if (!File.Exists(this_item_header))
{
this_item_header = this_header;
}
if (!File.Exists(this_item_footer))
{
this_item_footer = this_footer;
}
// Now, assign all of these
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Get the HTML source for all the headers and footers");
}
returnValue.Set_Header_Footer_Source(this_header, this_footer, this_item_header, this_item_footer);
if (Tracer != null)
{
Tracer.Add_Trace("Web_Skin_Utilities.Build_Skin", "Returning the fully built web skin");
}
return(returnValue);
}