//
//====================================================================================================
/// <summary>
/// Returns the Alias link (SourceLink) from the actual link (DestinationLink)
/// </summary>
public static string getLinkAlias(CoreController core, int PageID, string QueryStringSuffix, string DefaultLink)
{
string linkAlias = DefaultLink;
List <LinkAliasModel> linkAliasList = LinkAliasModel.createPageList(core.cpParent, PageID, QueryStringSuffix);
if (linkAliasList.Count > 0)
{
linkAlias = linkAliasList.First().name;
if (linkAlias.left(1) != "/")
{
linkAlias = "/" + linkAlias;
}
}
return(linkAlias);
}
//
//=============================================================================
/// <summary>
/// Executes the current route. To determine the route:
/// route can be from URL, or from routeOverride
/// how to process route
/// -- urlParameters - /urlParameter(0)/urlParameter(1)/etc.
/// -- first try full url, then remove them from the left and test until last, try just urlParameter(0)
/// ---- so url /a/b/c, with addon /a and addon /a/b -> would run addon /a/b
///
/// </summary>
/// <returns>The doc created by the default addon. (html, json, etc)</returns>
public static string executeRoute(CoreController core, string routeOverride = "")
{
string result = "";
var sw = new Stopwatch();
sw.Start();
LogController.log(core, "CoreController executeRoute, enter", BaseClasses.CPLogBaseClass.LogLevel.Trace);
try {
if (core.appConfig != null)
{
//
// -- test fix for 404 response during routing - could it be a response left over from processing before we are called
core.webServer.setResponseStatus(WebServerController.httpResponseStatus200_Success);
//
// -- execute intercept methods first, like login, that run before the route that returns the page
// -- intercept routes should be addons alos
//
// -- determine the route: try routeOverride
string normalizedRoute = GenericController.normalizeRoute(routeOverride);
if (string.IsNullOrEmpty(normalizedRoute))
{
//
// -- no override, try argument route (remoteMethodAddon=)
normalizedRoute = GenericController.normalizeRoute(core.docProperties.getText(RequestNameRemoteMethodAddon));
if (string.IsNullOrEmpty(normalizedRoute))
{
//
// -- no override or argument, use the url as the route
normalizedRoute = GenericController.normalizeRoute(core.webServer.requestPathPage.ToLowerInvariant());
}
}
//
// -- legacy ajaxfn methods
string AjaxFunction = core.docProperties.getText(RequestNameAjaxFunction);
if (!string.IsNullOrEmpty(AjaxFunction))
{
//
// -- Need to be converted to Url parameter addons
switch ((AjaxFunction))
{
case ajaxGetFieldEditorPreferenceForm: {
//
// moved to Addons.AdminSite
return((new Contensive.Processor.Addons.AdminSite.GetFieldEditorPreference()).Execute(core.cpParent).ToString());
}
case AjaxGetDefaultAddonOptionString: {
//
// moved to Addons.AdminSite
return((new Contensive.Processor.Addons.AdminSite.GetAjaxDefaultAddonOptionStringClass()).Execute(core.cpParent).ToString());
}
case AjaxSetVisitProperty: {
//
// moved to Addons.AdminSite
return((new Contensive.Processor.Addons.AdminSite.SetAjaxVisitPropertyClass()).Execute(core.cpParent).ToString());
}
case AjaxGetVisitProperty: {
//
// moved to Addons.AdminSite
return((new Contensive.Processor.Addons.AdminSite.GetAjaxVisitPropertyClass()).Execute(core.cpParent).ToString());
}
case AjaxData: {
//
// moved to Addons.AdminSite
return((new Contensive.Processor.Addons.AdminSite.ProcessAjaxDataClass()).Execute(core.cpParent).ToString());
}
case AjaxPing: {
//
// moved to Addons.AdminSite
return((new Contensive.Processor.Addons.AdminSite.GetOKClass()).Execute(core.cpParent).ToString());
}
case AjaxOpenIndexFilter: {
//
// moved to Addons.AdminSite
return((new Contensive.Processor.Addons.AdminSite.OpenAjaxIndexFilterClass()).Execute(core.cpParent).ToString());
}
case AjaxOpenIndexFilterGetContent: {
//
// moved to Addons.AdminSite
return((new Contensive.Processor.Addons.AdminSite.OpenAjaxIndexFilterGetContentClass()).Execute(core.cpParent).ToString());
}
case AjaxCloseIndexFilter: {
//
// moved to Addons.AdminSite
return((new Contensive.Processor.Addons.AdminSite.CloseAjaxIndexFilterClass()).Execute(core.cpParent).ToString());
}
default: {
//
// -- unknown method, log warning
return(string.Empty);
}
}
}
//
// -- legacy email intercept methods
if (core.docProperties.getInteger(rnEmailOpenFlag) > 0)
{
//
// -- Process Email Open
return((new Contensive.Processor.Addons.Primitives.OpenEmailClass()).Execute(core.cpParent).ToString());
}
if (core.docProperties.getInteger(rnEmailClickFlag) > 0)
{
//
// -- Process Email click, execute and continue
(new Contensive.Processor.Addons.Primitives.ClickEmailClass()).Execute(core.cpParent).ToString();
}
if (!string.IsNullOrWhiteSpace(core.docProperties.getText(rnEmailBlockRecipientEmail)))
{
//
// -- Process Email block
return((new Contensive.Processor.Addons.Primitives.BlockEmailClass()).Execute(core.cpParent).ToString());
}
//
// -- legacy form process methods
string formType = core.docProperties.getText(core.docProperties.getText("ccformsn") + "type");
if (!string.IsNullOrEmpty(formType))
{
//
// set the meta content flag to show it is not needed for the head tag
switch (formType)
{
case FormTypeAddonStyleEditor: {
//
result = (new Contensive.Processor.Addons.Primitives.ProcessAddonStyleEditorClass()).Execute(core.cpParent).ToString();
break;
}
case FormTypeAddonSettingsEditor: {
//
result = (new Contensive.Processor.Addons.Primitives.ProcessAddonSettingsEditorClass()).Execute(core.cpParent).ToString();
break;
}
case FormTypeSendPassword: {
//
result = (new Contensive.Processor.Addons.Primitives.processSendPasswordFormClass()).Execute(core.cpParent).ToString();
break;
}
case FormTypeLogin:
case "l09H58a195": {
//
result = (new Contensive.Processor.Addons.Primitives.ProcessLoginDefaultClass()).Execute(core.cpParent).ToString();
break;
}
case FormTypeToolsPanel: {
//
result = (new Contensive.Processor.Addons.Primitives.processFormToolsPanelClass()).Execute(core.cpParent).ToString();
break;
}
case FormTypePageAuthoring: {
//
result = (new Contensive.Processor.Addons.Primitives.processFormQuickEditingClass()).Execute(core.cpParent).ToString();
break;
}
case FormTypeActiveEditor: {
//
result = (new Contensive.Processor.Addons.Primitives.ProcessActiveEditorClass()).Execute(core.cpParent).ToString();
break;
}
case FormTypeSiteStyleEditor: {
//
result = (new Contensive.Processor.Addons.Primitives.ProcessSiteStyleEditorClass()).Execute(core.cpParent).ToString();
break;
}
case FormTypeHelpBubbleEditor: {
//
result = (new Contensive.Processor.Addons.Primitives.processHelpBubbleEditorClass()).Execute(core.cpParent).ToString();
break;
}
case FormTypeJoin: {
//
result = (new Contensive.Processor.Addons.Primitives.processJoinFormClass()).Execute(core.cpParent).ToString();
break;
}
default: {
break;
}
}
}
//
// -- legacy methods=
string HardCodedPage = core.docProperties.getText(RequestNameHardCodedPage);
if (!string.IsNullOrEmpty(HardCodedPage))
{
switch (GenericController.toLCase(HardCodedPage))
{
case HardCodedPageLogout: {
//
// -- logout intercept
(new Contensive.Processor.Addons.Primitives.ProcessLogoutMethodClass()).Execute(core.cpParent);
//
// -- redirect to the route without the method
string routeWithoutQuery = modifyLinkQuery(core.webServer.requestUrlSource, "method", "", false);
core.webServer.redirect(routeWithoutQuery, "Redirect to route without 'method' because login was successful.");
return(string.Empty);
}
case HardCodedPageSendPassword: {
//
return((new Contensive.Processor.Addons.Primitives.ProcessSendPasswordMethodClass()).Execute(core.cpParent).ToString());
}
case HardCodedPageResourceLibrary: {
//
return((new Contensive.Processor.Addons.Primitives.ProcessResourceLibraryMethodClass()).Execute(core.cpParent).ToString());
}
case HardCodedPageLoginDefault: {
//
if (core.session.isAuthenticated)
{
//
// -- if authenticated, redirect to the route without the method
string routeWithoutQuery = modifyLinkQuery(core.webServer.requestUrlSource, "method", "", false);
core.webServer.redirect(routeWithoutQuery, "Redirect to route without 'method' because login was successful.");
return(string.Empty);
}
//
// -- process the login method, or return the login form
return((new Contensive.Processor.Addons.Primitives.ProcessLoginDefaultMethodClass()).Execute(core.cpParent).ToString());
}
case HardCodedPageLogin: {
//
if (core.session.isAuthenticated)
{
//
// -- if authenticated, redirect to the route without the method
string routeWithoutQuery = modifyLinkQuery(core.webServer.requestUrlSource, "method", "", false);
core.webServer.redirect(routeWithoutQuery, "Redirect to route without 'method' because login was successful.");
return(string.Empty);
}
//
// -- process the login method, or return the login form
return((new Contensive.Processor.Addons.Primitives.ProcessLoginMethodClass()).Execute(core.cpParent).ToString());
}
case HardCodedPageLogoutLogin: {
//
return((new Contensive.Processor.Addons.Primitives.ProcessLogoutLoginMethodClass()).Execute(core.cpParent).ToString());
}
case HardCodedPageSiteExplorer: {
//
return((new Contensive.Processor.Addons.Primitives.ProcessSiteExplorerMethodClass()).Execute(core.cpParent).ToString());
}
case HardCodedPageStatus: {
//
return((new Contensive.Processor.Addons.Diagnostics.StatusClass()).Execute(core.cpParent).ToString());
}
case HardCodedPageRedirect: {
//
return((new Contensive.Processor.Addons.Primitives.ProcessRedirectMethodClass()).Execute(core.cpParent).ToString());
}
case HardCodedPageExportAscii: {
//
return((new Contensive.Processor.Addons.Primitives.ProcessExportAsciiMethodClass()).Execute(core.cpParent).ToString());
}
default: {
break;
}
}
}
//
// -- try route Dictionary (addons, admin, link forwards, link alias), from full route to first segment one at a time
// -- so route /this/and/that would first test /this/and/that, then test /this/and, then test /this
string routeTest = normalizedRoute;
bool routeFound = false;
int routeCnt = 100;
do
{
routeFound = core.routeMap.routeDictionary.ContainsKey(routeTest);
if (routeFound)
{
break;
}
if (routeTest.IndexOf("/") < 0)
{
break;
}
routeTest = routeTest.left(routeTest.LastIndexOf("/"));
routeCnt -= 1;
} while ((routeCnt > 0) && (!routeFound));
//
// -- execute route
if (routeFound)
{
RouteMapModel.RouteClass route = core.routeMap.routeDictionary[routeTest];
switch (route.routeType)
{
case RouteMapModel.RouteTypeEnum.admin: {
//
// -- admin site
AddonModel addon = DbBaseModel.create <AddonModel>(core.cpParent, addonGuidAdminSite);
if (addon == null)
{
LogController.logError(core, new GenericException("The admin site addon could not be found by guid [" + addonGuidAdminSite + "]."));
return("The default admin site addon could not be found. Please run an upgrade on this application to restore default services (command line> cc -a appName -r )");
}
else
{
return(core.addon.execute(addon, new CPUtilsBaseClass.addonExecuteContext {
addonType = CPUtilsBaseClass.addonContext.ContextAdmin,
errorContextMessage = "calling admin route [" + addonGuidAdminSite + "] during execute route method"
}));
}
}
case RouteMapModel.RouteTypeEnum.remoteMethod: {
//
// -- remote method
AddonModel addon = core.addonCache.getAddonById(route.remoteMethodAddonId);
if (addon == null)
{
LogController.logError(core, new GenericException("The addon for remoteMethodAddonId [" + route.remoteMethodAddonId + "] could not be opened."));
return("");
}
else
{
CPUtilsBaseClass.addonExecuteContext executeContext = new CPUtilsBaseClass.addonExecuteContext {
addonType = CPUtilsBaseClass.addonContext.ContextRemoteMethodJson,
cssContainerClass = "",
cssContainerId = "",
hostRecord = new CPUtilsBaseClass.addonExecuteHostRecordContext {
contentName = core.docProperties.getText("hostcontentname"),
fieldName = "",
recordId = core.docProperties.getInteger("HostRecordID")
},
errorContextMessage = "calling remote method addon [" + route.remoteMethodAddonId + "] during execute route method"
};
return(core.addon.execute(addon, executeContext));
}
}
case RouteMapModel.RouteTypeEnum.linkAlias: {
//
// - link alias
// -- all the query string values have already been added to doc properties, so do not over write them.
// -- consensus is that since the link alias (permalink, long-tail url, etc) comes first on the left, that the querystring should override
// -- so http://www.mySite.com/My-Blog-Post?bid=9 means use the bid not the bid from the link-alias
LinkAliasModel linkAlias = DbBaseModel.create <LinkAliasModel>(core.cpParent, route.linkAliasId);
if (linkAlias != null)
{
// -- set the link alias page number, unless it has been overridden
if (!core.docProperties.containsKey("bid"))
{
core.docProperties.setProperty("bid", linkAlias.pageId);
}
if (!string.IsNullOrWhiteSpace(linkAlias.queryStringSuffix))
{
string[] keyValuePairs = linkAlias.queryStringSuffix.Split('&');
// -- iterate through all the key=value pairs
foreach (var keyEqualsValue in keyValuePairs)
{
string[] keyValue = keyEqualsValue.Split('=');
if (!string.IsNullOrEmpty(keyValue[0]))
{
if (!core.docProperties.containsKey(keyValue[0]))
{
if (keyValue.Length > 1)
{
core.docProperties.setProperty(keyValue[0], keyValue[1]);
}
else
{
core.docProperties.setProperty(keyValue[0], string.Empty);
}
}
}
}
}
}
break;
}
case RouteMapModel.RouteTypeEnum.linkForward: {
//
// -- link forward
LinkForwardModel linkForward = DbBaseModel.create <LinkForwardModel>(core.cpParent, route.linkForwardId);
return(core.webServer.redirect(linkForward.destinationLink, "Link Forward #" + linkForward.id + ", " + linkForward.name));
}
default: {
break;
}
}
}
//
// -- default route
int defaultAddonId = 0;
if (core.doc.domain != null)
{
defaultAddonId = core.doc.domain.defaultRouteId;
}
if (defaultAddonId == 0)
{
defaultAddonId = core.siteProperties.defaultRouteId;
}
if (defaultAddonId > 0)
{
//
// -- default route is run if no other route is found, which includes the route=defaultPage (default.aspx)
CPUtilsBaseClass.addonExecuteContext executeContext = new CPUtilsBaseClass.addonExecuteContext {
addonType = CPUtilsBaseClass.addonContext.ContextPage,
cssContainerClass = "",
cssContainerId = "",
hostRecord = new CPUtilsBaseClass.addonExecuteHostRecordContext {
contentName = "",
fieldName = "",
recordId = 0
},
errorContextMessage = "calling default route addon [" + defaultAddonId + "] during execute route method"
};
return(core.addon.execute(DbBaseModel.create <AddonModel>(core.cpParent, defaultAddonId), executeContext));
}
//
// -- no route
LogController.logWarn(core, "executeRoute called with an unknown route [" + normalizedRoute + "], and no default route is set to handle it. Go to the admin site, open preferences and set a detault route. Typically this is Page Manager for websites or an authorization error for remote applications.");
result = "<p>This site is not configured for website traffic. Please set the default route.</p>";
}
} catch (Exception ex) {
LogController.logError(core, ex);
} finally {
// if (core.doc.routeDictionaryChanges) { DefaultSite.configurationClass.loadRouteMap(cp))}
LogController.log(core, "CoreController executeRoute, exit", BaseClasses.CPLogBaseClass.LogLevel.Trace);
}
return(result);
}
