/// <summary> [HELPER] Gets the all information, including the HTML, for an item aggregation child page </summary>
/// <param name="AggregationCode"> Code for the aggregation </param>
/// <param name="RequestedLanguage"> Requested language to retrieve </param>
/// <param name="DefaultLanguage"> Default interface language, in case the requested language does not exist </param>
/// <param name="ChildPageCode"> Code the requested child page </param>
/// <param name="Tracer"></param>
/// <returns> Fully built object, based on the aggregation configuration and reading the source HTML file </returns>
/// <remarks> This may be public now, but this will be converted into a private helped class with
/// the release of SobekCM 5.0 </remarks>
public static HTML_Based_Content get_item_aggregation_html_child_page(string AggregationCode, Web_Language_Enum RequestedLanguage, Web_Language_Enum DefaultLanguage, string ChildPageCode, Custom_Tracer Tracer)
{
// Try to pull from the cache
HTML_Based_Content cacheInst = CachedDataManager.Aggregations.Retrieve_Aggregation_HTML_Based_Content(AggregationCode, RequestedLanguage, ChildPageCode, Tracer);
if (cacheInst != null)
{
Tracer.Add_Trace("AggregationServices.get_item_aggregation_html_child_page", "Found built child page in the cache");
return(cacheInst);
}
// Get the language-specific item aggregation object
Item_Aggregation itemAggr = get_item_aggregation(AggregationCode, RequestedLanguage, DefaultLanguage, Tracer);
if (itemAggr == null)
{
Tracer.Add_Trace("AggregationServices.get_item_aggregation_html_child_page", "Item aggregation object was NULL.. May not be a valid aggregation code");
return(null);
}
// Get the child page object
Tracer.Add_Trace("AggregationServices.get_item_aggregation_html_child_page", "Get child page object from the language-specific item aggregation");
Item_Aggregation_Child_Page childPage = itemAggr.Child_Page_By_Code(ChildPageCode);
if (childPage == null)
{
Tracer.Add_Trace("AggregationServices.get_item_aggregation_html_child_page", "Child page does not exist in language-specific item agggregation");
return(null);
}
if (childPage.Source_Data_Type != Item_Aggregation_Child_Source_Data_Enum.Static_HTML)
{
Tracer.Add_Trace("AggregationServices.get_item_aggregation_html_child_page", "Child page exists in language-specific item aggregation, but it is not of type static html");
return(null);
}
string path = Path.Combine("/design/", itemAggr.ObjDirectory, childPage.Source);
string file = HttpContext.Current.Server.MapPath(path);
Tracer.Add_Trace("AggregationServices.get_item_aggregation_html_child_page", "Attempting to read source file for child page");
HTML_Based_Content results = HTML_Based_Content_Reader.Read_HTML_File(file, true, Tracer);
if (results != null)
{
Tracer.Add_Trace("AggregationServices.get_item_aggregation_html_child_page", "Storing build child page in the cache");
CachedDataManager.Aggregations.Store_Aggregation_HTML_Based_Content(AggregationCode, RequestedLanguage, ChildPageCode, results, Tracer);
}
else
{
Tracer.Add_Trace("AggregationServices.get_item_aggregation_html_child_page", "Child page object returned from HTML_Based_Content_Reader was null.. returning NULL");
}
return(results);
}
/// <summary> Gets the browse or info object and any other needed data for display ( text to display) </summary>
/// <param name="Current_Mode"> Mode / navigation information for the current request</param>
/// <param name="Aggregation_Object"> Item Aggregation object</param>
/// <param name="Base_Directory"> Base directory location under which the the CMS/info source file will be found</param>
/// <param name="Current_User"> Currently logged on user, which can determine which items to show </param>
/// <param name="Tracer"> Trace object keeps a list of each method executed and important milestones in rendering </param>
/// <param name="Browse_Object"> [OUT] Stores all the information about this browse or info </param>
/// <param name="Complete_Result_Set_Info"> [OUT] Information about the entire set of results </param>
/// <param name="Paged_Results"> [OUT] List of search results for the requested page of results </param>
/// <param name="Browse_Info_Display_Text"> [OUT] Static HTML-based content to be displayed if this is browing a staticly created html source file </param>
/// <returns> TRUE if successful, otherwise FALSE </returns>
/// <remarks> This attempts to pull the objects from the cache. If unsuccessful, it builds the objects from the
/// database and hands off to the <see cref="CachedDataManager" /> to store in the cache </remarks>
protected static bool Get_Browse_Info(Navigation_Object Current_Mode,
Item_Aggregation Aggregation_Object,
string Base_Directory,
User_Object Current_User,
Custom_Tracer Tracer,
out Item_Aggregation_Child_Page Browse_Object,
out Search_Results_Statistics Complete_Result_Set_Info,
out List <iSearch_Title_Result> Paged_Results,
out HTML_Based_Content Browse_Info_Display_Text)
{
if (Tracer != null)
{
Tracer.Add_Trace("abstractHtmlSubwriter.Get_Browse_Info", String.Empty);
}
// Set output initially to null
Paged_Results = null;
Complete_Result_Set_Info = null;
Browse_Info_Display_Text = null;
// First, make sure the browse submode is valid
Browse_Object = Aggregation_Object.Child_Page_By_Code(Current_Mode.Info_Browse_Mode);
if (Browse_Object == null)
{
Current_Mode.Error_Message = "Unable to retrieve browse/info item '" + Current_Mode.Info_Browse_Mode + "'";
return(false);
}
// Is this a table result, or a string?
switch (Browse_Object.Source_Data_Type)
{
case Item_Aggregation_Child_Source_Data_Enum.Database_Table:
// Set the current sort to ZERO, if currently set to ONE and this is an ALL BROWSE.
// Those two sorts are the same in this case
int sort = Current_Mode.Sort.HasValue ? Math.Max(Current_Mode.Sort.Value, ((ushort)1)) : 1;
if ((sort == 0) && (Browse_Object.Code == "all"))
{
sort = 1;
}
// Special code if this is a JSON browse
string browse_code = Current_Mode.Info_Browse_Mode;
if (Current_Mode.Writer_Type == Writer_Type_Enum.JSON)
{
browse_code = browse_code + "_JSON";
sort = 12;
}
// Get the page count in the results
int current_page_index = Current_Mode.Page.HasValue ? Math.Max(Current_Mode.Page.Value, ((ushort)1)) : 1;
// Determine if this is a special search type which returns more rows and is not cached.
// This is used to return the results as XML and DATASET
bool special_search_type = false;
int results_per_page = 20;
if ((Current_Mode.Writer_Type == Writer_Type_Enum.XML) || (Current_Mode.Writer_Type == Writer_Type_Enum.DataSet))
{
results_per_page = 1000000;
special_search_type = true;
sort = 2; // Sort by BibID always for these
}
Tracer.Add_Trace("abstractHtmlSubwriter.Get_Browse_Info", "Current_Mode.Writer_Type=[" + Current_Mode.Writer_Type.ToString() + "].");
Tracer.Add_Trace("abstractHtmlSubwriter.Get_Browse_Info", "Current_Mode.Results_Display_Type=[" + Current_Mode.Result_Display_Type + "].");
if (String.Equals(Current_Mode.Result_Display_Type, "timeline", StringComparison.OrdinalIgnoreCase))
{
Tracer.Add_Trace("abstractHtmlSubwriter.Get_Browse_Info", "Is timeline, setting browse results_per_page and sort.");
results_per_page = 20000;
sort = 12;
}
// Set the flags for how much data is needed. (i.e., do we need to pull ANYTHING? or
// perhaps just the next page of results ( as opposed to pulling facets again).
bool need_browse_statistics = true;
bool need_paged_results = true;
if ((!special_search_type) && (Current_User == null))
{
// Look to see if the browse statistics are available on any cache for this browse
Complete_Result_Set_Info = CachedDataManager.Retrieve_Browse_Result_Statistics(Aggregation_Object.Code, browse_code, Tracer);
if (Complete_Result_Set_Info != null)
{
need_browse_statistics = false;
}
// Look to see if the paged results are available on any cache..
Paged_Results = CachedDataManager.Retrieve_Browse_Results(Aggregation_Object.Code, browse_code, current_page_index, sort, (uint)results_per_page, Tracer);
if (Paged_Results != null)
{
need_paged_results = false;
}
}
// Was a copy found in the cache?
if ((!need_browse_statistics) && (!need_paged_results))
{
if (Tracer != null)
{
Tracer.Add_Trace("SobekCM_Assistant.Get_Browse_Info", "Browse statistics and paged results retrieved from cache");
}
}
else
{
if (Tracer != null)
{
Tracer.Add_Trace("SobekCM_Assistant.Get_Browse_Info", "Building results information");
}
// Try to pull more than one page, so we can cache the next page or so
List <List <iSearch_Title_Result> > pagesOfResults;
// Get from the hierarchy object
Multiple_Paged_Results_Args returnArgs = Item_Aggregation_Utilities.Get_Browse_Results(Aggregation_Object, Browse_Object, current_page_index, sort, results_per_page, !special_search_type, need_browse_statistics, Current_User, Tracer);
if (need_browse_statistics)
{
Complete_Result_Set_Info = returnArgs.Statistics;
}
pagesOfResults = returnArgs.Paged_Results;
if ((pagesOfResults != null) && (pagesOfResults.Count > 0))
{
Paged_Results = pagesOfResults[0];
}
// Save the overall result set statistics to the cache if something was pulled
if ((!special_search_type) && (Current_User == null))
{
if ((need_browse_statistics) && (Complete_Result_Set_Info != null))
{
CachedDataManager.Store_Browse_Result_Statistics(Aggregation_Object.Code, browse_code, Complete_Result_Set_Info, Tracer);
}
// Save the overall result set statistics to the cache if something was pulled
if ((need_paged_results) && (Paged_Results != null))
{
CachedDataManager.Store_Browse_Results(Aggregation_Object.Code, browse_code, current_page_index, sort, (uint)results_per_page, pagesOfResults, Tracer);
}
}
}
break;
case Item_Aggregation_Child_Source_Data_Enum.Static_HTML:
Browse_Info_Display_Text = SobekEngineClient.Aggregations.Get_Aggregation_HTML_Child_Page(Aggregation_Object.Code, Aggregation_Object.Language, UI_ApplicationCache_Gateway.Settings.System.Default_UI_Language, Browse_Object.Code, Tracer);
break;
}
return(true);
}