delphimvcframework/sources/MVCFramework.pas

2543 lines
76 KiB
ObjectPascal
Raw Normal View History

2013-10-30 00:48:23 +01:00
unit MVCFramework;
{$RTTI EXPLICIT
2014-05-22 01:06:35 +02:00
METHODS([vcPublic, vcPublished, vcProtected])
2013-10-30 00:48:23 +01:00
FIELDS(DefaultFieldRttiVisibility)
PROPERTIES(DefaultPropertyRttiVisibility)}
{$WARNINGS OFF}
2013-10-30 00:48:23 +01:00
interface
uses
System.Generics.Collections,
MVCFramework.Logger,
Web.HTTPApp,
System.RTTI,
System.Classes,
Data.DB,
System.SysUtils,
MVCFramework.Commons,
MVCFramework.View.Cache,
IdHeaderList,
MVCFramework.ApplicationSession,
MVCFramework.Session,
StompTypes,
ObjectsMappers
2014-09-05 12:47:40 +02:00
{$IF CompilerVErsion < 27}
, Data.DBXJSON
2014-09-05 12:47:40 +02:00
{$ELSE}
, System.JSON, Web.ApacheHTTP
2014-04-16 22:52:25 +02:00
{$IFEND}
, ReqMulti {Delphi XE4 (all update) and XE5 (with no update) dont contains this unit. Look for the bug in QC};
2013-10-30 00:48:23 +01:00
type
TMVCHTTPMethodType = (httpGET, httpPOST, httpPUT, httpDELETE, httpHEAD,
httpOPTIONS, httpPATCH, httpTRACE);
TMVCHTTPMethods = set of TMVCHTTPMethodType;
TDMVCSerializationType = TSerializationType;
// RTTI ATTRIBUTES
MVCHTTPMethodAttribute = class(TCustomAttribute)
private
FMVCHTTPMethods: TMVCHTTPMethods;
function GetMVCHTTPMethodsAsString: string;
public
constructor Create(AMVCHTTPMethods: TMVCHTTPMethods);
property MVCHTTPMethods: TMVCHTTPMethods read FMVCHTTPMethods;
property MVCHTTPMethodsAsString: string read GetMVCHTTPMethodsAsString;
end;
MVCHTTPMethodsAttribute = MVCHTTPMethodAttribute; //just an alias
MVCBaseAttribute = class(TCustomAttribute)
end;
MVCStringAttribute = class(MVCBaseAttribute)
private
FValue: string;
public
constructor Create(const Value: string);
property Value: string read FValue;
end;
MVCConsumesAttribute = class(MVCStringAttribute)
end;
MVCDocAttribute = class(MVCStringAttribute)
end;
MVCProducesAttribute = class(MVCStringAttribute)
private
FProduceEncoding: string;
procedure SetProduceEncoding(const Value: string);
public
constructor Create(const Value: string); overload;
constructor Create(const Value: string;
const ProduceEncoding: string); overload;
property ProduceEncoding: string read FProduceEncoding
write SetProduceEncoding;
end;
MVCPathAttribute = class(MVCBaseAttribute)
private
FPath: string;
public
constructor Create(const Value: string); overload;
constructor Create; overload;
property Path: string read FPath;
end;
TMVCWebRequest = class
public
constructor Create(AWebRequest: TWebRequest); virtual;
private
FWebRequest: TWebRequest;
FParamsTable: TMVCRequestParamsTable;
FContentType: string;
FCharset: string;
FContentCharset: string;
function GetHeader(const Name: string): string;
// function GetHeaderValue(const Name: string): string;
function GetPathInfo: string;
function GetParamAll(const ParamName: string): string;
function GetIsAjax: boolean;
function GetHTTPMethod: TMVCHTTPMethodType;
function GetHTTPMethodAsString: string;
function GetParamAllAsInteger(const ParamName: string): Integer;
function GetClientPreferHTML: boolean;
function GetFiles: TAbstractWebRequestFiles;
strict protected
FBodyAsJSONValue: TJSONValue;
FParamNames: TArray<string>;
public
destructor Destroy; override;
procedure SetParamsTable(AParamsTable: TMVCRequestParamsTable);
function GetParamNames: TArray<string>;
function ClientIP: string; virtual;
function ClientPrefer(MimeType: string): boolean;
function ThereIsRequestBody: boolean;
function Accept: string;
function QueryStringParam(Name: string): string; virtual;
function QueryStringParamExists(Name: string): boolean; virtual;
function ContentParam(Name: string): string; virtual;
function Cookie(Name: string): string; virtual;
property PathInfo: string read GetPathInfo;
function Body: string;
function BodyAs<T: class, constructor>(const RootProperty: string = ''): T;
function BodyAsListOf<T: class, constructor>(const RootProperty
: string = ''): TObjectList<T>;
function BodyAsJSONObject: TJSONObject;
function BodyAsJSONValue: TJSONValue;
property Headers[const HeaderName: string]: string read GetHeader;
property ParamsAsInteger[const ParamName: string]: Integer
read GetParamAllAsInteger;
property Params[const ParamName: string]: string read GetParamAll;
property IsAjax: boolean read GetIsAjax;
property HTTPMethod: TMVCHTTPMethodType read GetHTTPMethod;
property HTTPMethodAsString: string read GetHTTPMethodAsString;
property RawWebRequest: TWebRequest read FWebRequest;
property ClientPreferHTML: boolean read GetClientPreferHTML;
property Files: TAbstractWebRequestFiles read GetFiles;
property ContentType: string read FContentType;
property ContentCharset: string read FContentCharset;
property Charset: string read FCharset;
end;
2013-10-30 00:48:23 +01:00
{$IF CompilerVersion >= 27}
2014-10-03 11:40:57 +02:00
TMVCApacheWebRequest = class(TMVCWebRequest)
public
constructor Create(AWebRequest: TWebRequest); override;
end;
{$ENDIF}
TMVCISAPIWebRequest = class(TMVCWebRequest)
public
constructor Create(AWebRequest: TWebRequest); override;
end;
2013-10-30 00:48:23 +01:00
TMVCINDYWebRequest = class(TMVCWebRequest)
public
constructor Create(AWebRequest: TWebRequest); override;
end;
2013-10-30 00:48:23 +01:00
2013-11-08 23:10:25 +01:00
{$IFDEF IOCP}
2013-10-30 00:48:23 +01:00
TMVCIOCPWebRequest = class(TMVCWebRequest)
public
constructor Create(AWebRequest: TWebRequest); override;
end;
2013-10-30 00:48:23 +01:00
2013-11-08 23:10:25 +01:00
{$ENDIF}
2013-10-30 00:48:23 +01:00
TMVCWebResponse = class
strict private
function GetCustomHeaders: TStrings;
private
FStreamOutputDone: boolean;
FFlushOnDestroy: boolean; // tristan
procedure SetStatusCode(const Value: Integer);
function GetStatusCode: Integer;
procedure SetReasonString(const Value: string);
function GetCookies: TCookieCollection;
procedure SetContentType(const Value: string);
function GetContentType: string;
procedure SetContent(const Value: string);
function GetContent: string;
function GetLocation: string;
procedure SetLocation(const Value: string);
function GetReasonString: string;
property Content: string read GetContent write SetContent;
protected // do not put this as "strict"
FWebResponse: TWebResponse;
public
constructor Create(AWebResponse: TWebResponse); virtual;
destructor Destroy; override;
procedure Flush;
procedure SetCustomHeader(const Name, Value: string);
procedure SetContentStream(AStream: TStream; AContentType: string);
procedure SendHeaders;
property CustomHeaders: TStrings read GetCustomHeaders;
property StatusCode: Integer read GetStatusCode write SetStatusCode;
property ReasonString: string read GetReasonString write SetReasonString;
property Cookies: TCookieCollection read GetCookies;
property ContentType: string read GetContentType write SetContentType;
property Location: string read GetLocation write SetLocation;
property RawWebResponse: TWebResponse read FWebResponse;
property FlushOnDestroy: boolean read FFlushOnDestroy write FFlushOnDestroy;
// tristan
end;
TMVCEngine = class;
TUser = class
private
FRoles: TList<string>;
FUserName: string;
FLoggedSince: TDateTime;
FRealm: string;
procedure SetUserName(const Value: string);
procedure SetLoggedSince(const Value: TDateTime);
function GetIsValidLoggedUser: boolean;
procedure SetRealm(const Value: string);
public
procedure SaveToSession(AWebSession: TWebSession);
function LoadFromSession(AWebSession: TWebSession): boolean;
procedure Clear;
property Roles: TList<string> read FRoles;
property UserName: string read FUserName write SetUserName;
property LoggedSince: TDateTime read FLoggedSince write SetLoggedSince;
property IsValid: boolean read GetIsValidLoggedUser;
property Realm: string read FRealm write SetRealm;
constructor Create; virtual;
destructor Destroy; override;
end;
TWebContext = class
private
FRequest: TMVCWebRequest;
FResponse: TMVCWebResponse;
FConfig: TMVCConfig;
FParamsTable: TMVCRequestParamsTable;
FData: TDictionary<string, string>;
FLoggedUser: TUser;
function GetData: TDictionary<string, string>;
protected
constructor Create(ARequest: TWebRequest; AResponse: TWebResponse;
AConfig: TMVCConfig); virtual;
procedure SetParams(AParamsTable: TMVCRequestParamsTable);
procedure Flush;
function GetLoggedUser: TUser;
public
ReservedData: TObject;
destructor Destroy; override;
property LoggedUser: TUser read GetLoggedUser;
property Request: TMVCWebRequest read FRequest;
property Response: TMVCWebResponse read FResponse;
property Config: TMVCConfig read FConfig;
property Data: TDictionary<string, string> read GetData;
end;
TMVCActionProc = reference to procedure(Context: TWebContext);
TMVCBase = class(TObject)
private
FMVCEngine: TMVCEngine;
FMVCConfig: TMVCConfig;
FApplicationSession: TWebApplicationSession;
protected
class function GetApplicationFileName: string;
class function GetApplicationFileNamePath: string;
procedure SetApplicationSession(const Value: TWebApplicationSession);
public
procedure SetMVCConfig(const Value: TMVCConfig);
function GetMVCConfig: TMVCConfig;
procedure SetMVCEngine(const Value: TMVCEngine);
function GetMVCEngine: TMVCEngine;
property ApplicationSession: TWebApplicationSession read FApplicationSession
write SetApplicationSession;
end;
TMVCController = class(TMVCBase)
private
FIsSessionStarted: boolean;
FSessionMustBeClose: boolean;
FViewModel: TMVCDataObjects;
FViewDataSets: TObjectDictionary<string, TDataSet>;
FContext: TWebContext;
FWebSession: TWebSession;
FResponseStream: TStringBuilder;
FContentCharset: string;
procedure SetContext(const Value: TWebContext);
procedure SetWebSession(const Value: TWebSession);
procedure SetContentType(const Value: string);
function GetContentType: string;
function GetWebSession: TWebSession;
function GetContentCharset: string;
procedure SetContentCharset(const Value: string);
// procedure Render<T: class>(ACollection: TObjectList<T>; AInstanceOwner: boolean;
// AJSONObjectActionProc: TJSONObjectActionProc; ASerializationType: TSerializationType); overload;
// procedure Render<T: class>(ACollection: TObjectList<T>; AInstanceOwner: boolean;
// AJSONObjectActionProc: TJSONObjectActionProc; ASerializationType: TSerializationType);
protected const
CLIENTID_KEY = '__clientid';
protected
function GetClientID: string;
procedure RaiseSessionExpired; virtual;
function GetCurrentWebModule: TWebModule;
function ResponseStream: TStringBuilder;
function GetNewStompClient(ClientID: string = ''): IStompClient;
procedure LoadView(const ViewNames: TArray<String>); virtual;
property Context: TWebContext read FContext write SetContext;
property Session: TWebSession read GetWebSession write SetWebSession;
procedure MVCControllerAfterCreate; virtual;
procedure MVCControllerBeforeDestroy; virtual;
property ContentType: string read GetContentType write SetContentType;
property ContentCharset: string read GetContentCharset
write SetContentCharset;
// Session
procedure SessionStart; virtual;
procedure SessionStop(ARaiseExceptionIfExpired: boolean = true); virtual;
procedure BindToSession(SessionID: string);
function SendSessionCookie(AContext: TWebContext): string;
// Renderers
procedure Render(const Content: string); overload; virtual;
procedure Render; overload; virtual;
procedure Render<T: class>(ACollection: TObjectList<T>;
AInstanceOwner: boolean = true;
AJSONObjectActionProc: TJSONObjectActionProc = nil;
ASerializationType: TDMVCSerializationType = TDMVCSerializationType.
Properties); overload;
procedure Render(AObject: TObject; AInstanceOwner: boolean = true;
ASerializationType: TDMVCSerializationType = TDMVCSerializationType.
Properties); overload; virtual;
procedure Render(ADataSet: TDataSet; AInstanceOwner: boolean = false;
AOnlySingleRecord: boolean = false;
AJSONObjectActionProc: TJSONObjectActionProc = nil); overload; virtual;
procedure Render(AJSONValue: TJSONValue; AInstanceOwner: boolean = true);
overload; virtual;
procedure RenderListAsProperty<T: class>(const APropertyName: string;
AObjectList: TObjectList<T>; AOwnsInstance: boolean = true;
AJSONObjectActionProc: TJSONObjectActionProc = nil);
procedure Render(E: Exception; ErrorItems: TList<string> = nil);
overload; virtual;
procedure Render(const AErrorCode: UInt16; const AErrorMessage: string;
const AErrorClassName: string = ''); overload;
procedure Render(const AErrorCode: UInt16; AJSONValue: TJSONValue;
AInstanceOwner: boolean = true); overload;
procedure Render(const AErrorCode: UInt16; AObject: TObject;
AInstanceOwner: boolean = true); overload;
procedure RenderStreamAndFree(const AStream: TStream);
deprecated 'Use Render(TStream,Boolean)';
procedure Render(const AStream: TStream;
AInstanceOwner: boolean = true); overload;
// messaging
procedure EnqueueMessageOnTopicOrQueue(const IsQueue: boolean;
const ATopic: string; AJSONObject: TJSONObject;
AOwnsInstance: boolean = true);
function ReceiveMessageFromTopic(const ATopic: string; ATimeout: Int64;
var JSONObject: TJSONObject): boolean;
// redirects
procedure Redirect(const URL: string);
// http return code
procedure ResponseStatusCode(const AStatusCode: UInt16;
AStatusText: string = '');
// streams and files
procedure SendStream(AStream: TStream; AOwnStream: boolean = true); virtual;
procedure SendFile(AFileName: string); virtual;
// filters before, after
procedure OnBeforeAction(Context: TWebContext; const AActionNAme: string;
var Handled: boolean); virtual;
procedure OnAfterAction(Context: TWebContext;
const AActionNAme: string); virtual;
property Config: TMVCConfig read GetMVCConfig;
public
// property ViewCache: TViewCache read FViewCache write SetViewCache;
procedure PushJSONToView(const AModelName: string; AModel: TJSONValue);
procedure PushObjectToView(const AModelName: string; AModel: TObject);
procedure PushDataSetToView(const AModelName: string; ADataSet: TDataSet);
constructor Create;
destructor Destroy; override;
end;
TMVCControllerClass = class of TMVCController;
IMVCMiddleware = interface
['{3278183A-124A-4214-AB4E-94CA4C22450D}']
procedure OnBeforeRouting(Context: TWebContext; var Handled: boolean);
procedure OnBeforeControllerAction(Context: TWebContext;
const AControllerQualifiedClassName: string; const AActionNAme: string;
var Handled: boolean);
procedure OnAfterControllerAction(Context: TWebContext;
const AActionNAme: string; const Handled: boolean);
end;
TMVCEngine = class(TComponent)
strict private
FApplicationSession: TWebApplicationSession;
private
FWebModule: TWebModule;
FSavedOnBeforeDispatch: THTTPMethodEvent;
FMVCConfig: TMVCConfig;
// FViewCache : TViewCache;
FMimeTypes: TDictionary<string, string>;
procedure SetApplicationSession(const Value: TWebApplicationSession);
protected
FConfiguredSessionTimeout: Int64;
FControllers: TList<TMVCControllerClass>;
FMiddleware: TList<IMVCMiddleware>;
procedure ExecuteBeforeRoutingMiddleware(Context: TWebContext;
var Handled: boolean);
procedure ExecuteBeforeControllerActionMiddleware(MVCEngine: TMVCEngine;
Context: TWebContext; const AControllerQualifiedClassName: string;
const AActionNAme: string; var Handled: boolean);
procedure ExecuteAfterControllerActionMiddleware(Context: TWebContext;
const AActionNAme: string; const Handled: boolean);
procedure ConfigDefaultValues; virtual;
procedure FixUpWebModule;
procedure OnBeforeDispatch(Sender: TObject; Request: TWebRequest;
Response: TWebResponse; var Handled: boolean); virtual;
function ExecuteAction(Sender: TObject; Request: TWebRequest;
Response: TWebResponse): boolean; virtual;
procedure LoadSystemControllers; virtual;
procedure ResponseErrorPage(E: Exception; Request: TWebRequest;
Response: TWebResponse); virtual;
public
class function GetCurrentSession(ASessionTimeout: UInt64;
const ASessionID: string; ARaiseExceptionIfExpired: boolean = true)
: TWebSession;
class function ExtractSessionIDFromWebRequest
(AWebRequest: TWebRequest): string;
constructor Create(WebModule: TWebModule;
ConfigProc: TProc<TMVCConfig> = nil); reintroduce;
destructor Destroy; override;
class function SendSessionCookie(AContext: TWebContext): string; overload;
class function SendSessionCookie(AContext: TWebContext; ASessionID: string)
: string; overload;
class function AddSessionToTheSessionList(const ASessionID: string;
ASessionTimeout: UInt64): TWebSession;
function GetSessionBySessionID(const ASessionID: string): TWebSession;
function AddController(AControllerClass: TMVCControllerClass)
: TMVCEngine; overload;
function AddMiddleware(AMiddleware: IMVCMiddleware): TMVCEngine;
// internal methods
function RegisteredControllers: TList<TMVCControllerClass>;
// http return codes
procedure Http404(AWebContext: TWebContext);
procedure Http500(AWebContext: TWebContext; AReasonText: string = '');
property Config: TMVCConfig read FMVCConfig; // allow a simple client code
property ApplicationSession: TWebApplicationSession read FApplicationSession
write SetApplicationSession;
end;
TMVCStaticContents = class(TMVCController)
public
// [MVCPath('/static/($filename)')]
class procedure SendFile(AFileName, AMimeType: string;
Context: TWebContext);
class function IsStaticFile(AViewPath, AWebRequestPath: string;
out ARealFileName: string): boolean;
class function IsScriptableFile(StaticFileName: string;
Config: TMVCConfig): boolean;
end;
2013-10-30 00:48:23 +01:00
2014-03-10 17:39:29 +01:00
type
TMVCConfigKey = class
public const
SessionTimeout = 'sessiontimeout';
DocumentRoot = 'document_root';
ViewPath = 'view_path';
DefaultContentType = 'default_content_type';
DefaultContentCharset = 'default_content_charset';
DefaultViewFileExtension = 'default_view_file_extension';
ISAPIPath = 'isapi_path';
StompServer = 'stompserver';
StompServerPort = 'stompserverport';
StompUsername = 'stompusername';
StompPassword = 'stomppassword';
Messaging = 'messaging';
AllowUnhandledAction = 'allow_unhandled_action'; // tristan
end;
2014-03-10 17:39:29 +01:00
2013-10-30 00:48:23 +01:00
function IsShuttingDown: boolean;
procedure EnterInShutdownState;
2015-10-18 16:35:50 +02:00
procedure InternalRender(const Content: string;
ContentType, ContentEncoding: string; Context: TWebContext); overload;
2015-10-18 16:35:50 +02:00
procedure InternalRenderText(const AContent: string;
ContentType, ContentEncoding: string; Context: TWebContext);
2015-10-18 16:35:50 +02:00
procedure InternalRender(AJSONValue: TJSONValue;
ContentType, ContentEncoding: string; Context: TWebContext;
AInstanceOwner: boolean = true); overload;
2013-12-04 13:06:18 +01:00
2013-10-30 00:48:23 +01:00
implementation
uses
System.SyncObjs,
idglobal,
IdGlobalProtocols,
System.DateUtils,
System.RegularExpressions,
WinApi.Windows,
System.TypInfo,
System.ioutils,
System.StrUtils,
Web.Win.IsapiHTTP,
MVCFramework.Router,
MVCFramework.View,
IdURI,
DuckListU,
IdStack
2013-10-30 00:48:23 +01:00
2013-11-08 23:10:25 +01:00
{$IFDEF IOCP},
Iocp.DSHTTPWebBroker
2013-11-05 14:57:50 +01:00
2013-11-08 23:10:25 +01:00
{$ELSE},
IdHTTPWebBrokerBridge
2013-11-05 14:57:50 +01:00
2013-11-08 23:10:25 +01:00
{$ENDIF},
MVCFramework.MessagingController,
Web.WebReq,
MVCFramework.SysControllers;
2013-10-30 00:48:23 +01:00
type
TIdHTTPAppRequestHack = class({$IFDEF IOCP}TIocpWebRequest
{$ELSE}TIdHTTPAppRequest{$ENDIF})
2013-10-30 00:48:23 +01:00
end;
2013-10-30 00:48:23 +01:00
threadvar ctx: TRTTIContext;
2013-10-30 01:09:09 +01:00
2013-10-30 00:48:23 +01:00
var
_IsShuttingDown: Int64 = 0;
// this variable is used by TInterlocked functions to handl<64>e the "shuttingdown" mode
2013-10-30 00:48:23 +01:00
{ TMVCEngine }
2013-10-30 00:48:23 +01:00
2015-10-18 16:35:50 +02:00
function TMVCEngine.AddController(AControllerClass: TMVCControllerClass)
: TMVCEngine;
2013-10-30 00:48:23 +01:00
begin
FControllers.Add(AControllerClass);
Result := Self;
2013-10-30 00:48:23 +01:00
end;
function TMVCEngine.AddMiddleware(AMiddleware: IMVCMiddleware): TMVCEngine;
begin
FMiddleware.Add(AMiddleware);
Result := Self;
end;
2015-04-01 17:01:23 +02:00
class function TMVCEngine.AddSessionToTheSessionList(const ASessionID: string;
ASessionTimeout: UInt64): TWebSession;
2015-04-01 17:01:23 +02:00
var
LSess: TWebSession;
2015-04-01 17:01:23 +02:00
begin
TMonitor.Enter(SessionList);
try
LSess := TMVCSessionFactory.GetInstance.CreateNewByType('memory',
ASessionID, ASessionTimeout);
SessionList.Add(ASessionID, LSess);
Result := LSess;
LSess.MarkAsUsed;
finally
TMonitor.Exit(SessionList);
end;
2015-04-01 17:01:23 +02:00
end;
2013-10-30 00:48:23 +01:00
procedure TMVCEngine.ConfigDefaultValues;
begin
Log(TLogLevel.levNormal, 'ENTER: Config default values');
Config[TMVCConfigKey.SessionTimeout] := '30'; // 30 minutes
Config[TMVCConfigKey.DocumentRoot] := '.\www';
Config[TMVCConfigKey.DefaultContentType] :=
TMVCConstants.DEFAULT_CONTENT_TYPE;
Config[TMVCConfigKey.DefaultContentCharset] :=
TMVCConstants.DEFAULT_CONTENT_CHARSET;
Config[TMVCConfigKey.DefaultViewFileExtension] := 'html';
Config[TMVCConfigKey.ViewPath] := 'templates';
Config[TMVCConfigKey.ISAPIPath] := '';
Config[TMVCConfigKey.StompServer] := 'localhost';
Config[TMVCConfigKey.StompServerPort] := '61613';
Config[TMVCConfigKey.StompUsername] := 'guest';
Config[TMVCConfigKey.StompPassword] := 'guest';
Config[TMVCConfigKey.Messaging] := 'false';
Config[TMVCConfigKey.AllowUnhandledAction] := 'false'; // tristan
FMimeTypes.Add('.html', TMVCMimeType.TEXT_HTML);
FMimeTypes.Add('.htm', TMVCMimeType.TEXT_HTML);
FMimeTypes.Add('.txt', TMVCMimeType.TEXT_PLAIN);
FMimeTypes.Add('.css', TMVCMimeType.TEXT_CSS);
FMimeTypes.Add('.js', TMVCMimeType.TEXT_JAVASCRIPT);
FMimeTypes.Add('.jpg', TMVCMimeType.IMAGE_JPEG);
FMimeTypes.Add('.jpeg', TMVCMimeType.IMAGE_JPEG);
FMimeTypes.Add('.png', TMVCMimeType.IMAGE_PNG);
FMimeTypes.Add('.appcache', TMVCMimeType.TEXT_CACHEMANIFEST);
Log(TLogLevel.levNormal, 'EXIT: Config default values');
2015-10-18 16:35:50 +02:00
end;
constructor TMVCEngine.Create(WebModule: TWebModule;
ConfigProc: TProc<TMVCConfig>);
begin
inherited Create(WebModule);
WebRequestHandler.CacheConnections := true;
WebRequestHandler.MaxConnections := 4096;
FMimeTypes := TDictionary<string, string>.Create;
FMVCConfig := TMVCConfig.Create;
FWebModule := WebModule;
FControllers := TList<TMVCControllerClass>.Create;
FMiddleware := TList<IMVCMiddleware>.Create;
// FViewCache := TViewCache.Create;
FixUpWebModule;
ConfigDefaultValues;
if Assigned(ConfigProc) then
begin
LogEnterMethod('Custom configuration proc');
ConfigProc(Self.FMVCConfig);
LogExitMethod('Custom configuration proc');
end;
LoadSystemControllers;
2013-10-30 00:48:23 +01:00
end;
destructor TMVCEngine.Destroy;
begin
FMimeTypes.Free;
FMVCConfig.Free;
FControllers.Free;
FMiddleware.Free;
// FViewCache.Free;
inherited;
2013-10-30 00:48:23 +01:00
end;
2015-04-01 17:01:23 +02:00
function TMVCEngine.ExecuteAction(Sender: TObject; Request: TWebRequest;
Response: TWebResponse): boolean;
2013-10-30 00:48:23 +01:00
var
SelectedController: TMVCController;
Context: TWebContext;
ParamsTable: TMVCRequestParamsTable;
Router: TMVCRouter;
StaticFileName: string;
ContentType: string;
Handled: boolean;
ResponseContentType, ResponseContentCharset: string;
begin
// LogEnterMethod(Request.PathInfo);
// try
Result := false;
ParamsTable := TMVCRequestParamsTable.Create;
try
Context := TWebContext.Create(Request, Response, FMVCConfig);
try
// Static file handling
if TMVCStaticContents.IsStaticFile(TPath.Combine(AppPath,
FMVCConfig[TMVCConfigKey.DocumentRoot]), Request.PathInfo,
StaticFileName) then
begin
// if TMVCStaticContents.IsScriptableFile(StaticFileName, FMVCConfig) then
// // execute the file
// begin
// ExecuteFile(StaticFileName, Context);
// end
// else // serve the file
// begin
if not FMimeTypes.TryGetValue(LowerCase(ExtractFileExt(StaticFileName)),
ContentType) then
ContentType := TMVCMimeType.APPLICATION_OCTETSTREAM;
TMVCStaticContents.SendFile(StaticFileName, ContentType, Context);
Result := true;
// end;
end
else
begin
Router := TMVCRouter.Create(Config);
try
ExecuteBeforeRoutingMiddleware(Context, Handled);
if not Handled then
begin
if Router.ExecuteRouting(Request.PathInfo,
TMVCRouter.StringMethodToHTTPMetod(Request.Method),
Request.ContentType, Request.Accept, FControllers,
FMVCConfig[TMVCConfigKey.DefaultContentType],
FMVCConfig[TMVCConfigKey.DefaultContentCharset], ParamsTable,
ResponseContentType, ResponseContentCharset) then
begin
SelectedController := Router.MVCControllerClass.Create;
try
SelectedController.SetMVCConfig(Config);
SelectedController.ApplicationSession := FApplicationSession;
Context.SetParams(ParamsTable);
SelectedController.SetContext(Context);
SelectedController.SetMVCEngine(Self);
// exception?
try
{ middlewares before controller action }
ExecuteBeforeControllerActionMiddleware(Self, Context,
Router.MVCControllerClass.QualifiedClassName,
Router.MethodToCall.Name, Handled);
if Handled then
Exit(true);
SelectedController.MVCControllerAfterCreate;
try
Handled := false;
// gets response contentype from MVCProduces attribute
SelectedController.ContentType := ResponseContentType;
SelectedController.ContentCharset := ResponseContentCharset;
SelectedController.OnBeforeAction(Context,
Router.MethodToCall.Name, Handled);
if not Handled then
begin
try
Router.MethodToCall.Invoke(SelectedController,
[Context]);
finally
SelectedController.OnAfterAction(Context,
Router.MethodToCall.Name);
end;
end;
if SelectedController.FSessionMustBeClose then
begin
// SessionList.Remove(SelectedController.Session.SessionID);
end
else
begin
end;
finally
SelectedController.MVCControllerBeforeDestroy;
end;
ExecuteAfterControllerActionMiddleware(Context,
Router.MethodToCall.Name, Handled);
except
on E: EMVCSessionExpiredException do
begin
LogException(E, E.DetailedMessage);
SelectedController.SessionStop(false);
SelectedController.ResponseStatusCode(E.HTTPErrorCode);
SelectedController.Render(E);
end;
on E: EMVCException do
begin
LogException(E, E.DetailedMessage);
SelectedController.ResponseStatusCode(E.HTTPErrorCode);
SelectedController.Render(E);
end;
on E: EInvalidOp do
begin
LogException(E, 'Invalid OP');
SelectedController.Render(E);
end;
on E: Exception do
begin
LogException(E, 'Global Action Exception Handler');
SelectedController.Render(E);
end;
end;
Context.Response.ContentType := SelectedController.ContentType;
Log(TLogLevel.levNormal, Request.Method + ':' +
Request.RawPathInfo + ' -> ' +
Router.MVCControllerClass.QualifiedClassName + ' - ' +
Response.StatusCode.ToString + ' ' + Response.ReasonString)
finally
SelectedController.Free;
end;
end
else
begin
if Config[TMVCConfigKey.AllowUnhandledAction] = 'false' then
// tristan
begin
Http404(Context);
Log(TLogLevel.levNormal, Request.Method + ':' +
Request.RawPathInfo + ' -> NO ACTION ' + ' - ' +
Response.StatusCode.ToString + ' ' + Response.ReasonString);
end
else
begin
Context.Response.FlushOnDestroy := false; // tristan
end;
end;
end;
finally
Router.Free;
end;
end; // end if IS_STATIC
finally
Context.Free;
end;
finally
ParamsTable.Free;
end;
// finally
// LogExitMethod(Request.PathInfo + ' [' + IntToStr(Response.StatusCode) + ' ' +
// Response.ReasonString + ']');
// end;
end;
procedure TMVCEngine.ExecuteAfterControllerActionMiddleware
(Context: TWebContext; const AActionNAme: string; const Handled: boolean);
var
middleware: IMVCMiddleware;
begin
for middleware in FMiddleware do
begin
middleware.OnAfterControllerAction(Context, AActionNAme, Handled);
end;
end;
2015-10-18 16:35:50 +02:00
procedure TMVCEngine.ExecuteBeforeControllerActionMiddleware
(MVCEngine: TMVCEngine; Context: TWebContext;
const AControllerQualifiedClassName: string; const AActionNAme: string;
var Handled: boolean);
2015-04-01 17:01:23 +02:00
var
LMiddleware: IMVCMiddleware;
2015-04-01 17:01:23 +02:00
begin
if not Handled then
for LMiddleware in FMiddleware do
begin
LMiddleware.OnBeforeControllerAction(Context,
AControllerQualifiedClassName, AActionNAme, Handled);
if Handled then
break;
end;
2015-04-01 17:01:23 +02:00
end;
2015-10-18 16:35:50 +02:00
procedure TMVCEngine.ExecuteBeforeRoutingMiddleware(Context: TWebContext;
var Handled: boolean);
var
middleware: IMVCMiddleware;
begin
if not Handled then
for middleware in FMiddleware do
begin
middleware.OnBeforeRouting(Context, Handled);
if Handled then
break;
end;
end;
2015-10-18 16:35:50 +02:00
class function TMVCEngine.ExtractSessionIDFromWebRequest
(AWebRequest: TWebRequest): string;
2015-10-18 16:35:50 +02:00
begin
Result := AWebRequest.CookieFields.Values[TMVCConstants.SESSION_TOKEN_NAME];
if not Result.IsEmpty then
Result := TIdURI.URLDecode(Result);
2013-10-30 00:48:23 +01:00
end;
2015-04-01 17:01:23 +02:00
procedure TMVCEngine.FixUpWebModule;
2013-10-30 00:48:23 +01:00
begin
FSavedOnBeforeDispatch := FWebModule.BeforeDispatch;
FWebModule.BeforeDispatch := OnBeforeDispatch;
2013-10-30 00:48:23 +01:00
end;
2015-10-18 16:35:50 +02:00
class function TMVCEngine.GetCurrentSession(ASessionTimeout: UInt64;
const ASessionID: string; ARaiseExceptionIfExpired: boolean): TWebSession;
2013-10-30 00:48:23 +01:00
var
// SessionID: string;
List: TObjectDictionary<string, TWebSession>;
IsExpired: boolean;
begin
List := SessionList;
TMonitor.Enter(List);
try
Result := nil;
// if ASessionID.IsEmpty then
// raise EMVCException.Create('Empty SessionID');
{ SESSION IS NOT AUTOCREATED BY DEFAULT }
if not ASessionID.IsEmpty then
begin
IsExpired := true;
if List.TryGetValue(ASessionID, Result) then
begin
IsExpired := MinutesBetween(now, Result.LastAccess) > ASessionTimeout;
// StrToInt(Config.Value['sessiontimeout']);
end;
if Assigned(Result) then
begin
if IsExpired then
begin
List.Remove(ASessionID); // remove expired session from session list
if ARaiseExceptionIfExpired then
raise EMVCSessionExpiredException.Create('Session expired')
else
Result := nil;
end
else
begin
Result.MarkAsUsed;
end;
end;
end;
finally
TMonitor.Exit(List);
end;
2015-10-18 16:35:50 +02:00
end;
function TMVCEngine.GetSessionBySessionID(const ASessionID: string)
: TWebSession;
2015-10-18 16:35:50 +02:00
begin
Result := TMVCEngine.GetCurrentSession
(StrToInt64(Config[TMVCConfigKey.SessionTimeout]), ASessionID, false);
if Assigned(Result) then
begin
Result.MarkAsUsed;
// TMVCEngine.SendSessionCookie(FContext, SessionID);
end;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCEngine.Http404(AWebContext: TWebContext);
begin
AWebContext.Response.StatusCode := 404;
AWebContext.Response.ReasonString := 'Not Found';
AWebContext.Response.Content := 'Not Found';
2013-10-30 00:48:23 +01:00
end;
procedure TMVCEngine.Http500(AWebContext: TWebContext; AReasonText: string);
begin
AWebContext.Response.StatusCode := 500;
AWebContext.Response.ReasonString := 'Internal server error: ' + AReasonText;
AWebContext.Response.Content := 'Internal server error: ' + AReasonText;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCEngine.LoadSystemControllers;
begin
Log(TLogLevel.levNormal, 'ENTER: LoadSystemControllers');
AddController(TMVCSystemController);
if Config[TMVCConfigKey.Messaging].ToLower.Equals('true') then
begin
AddController(TMVCBUSController);
Log(TLogLevel.levNormal, 'Loaded system controller ' +
TMVCBUSController.QualifiedClassName);
end;
Log(TLogLevel.levNormal, 'EXIT: LoadSystemControllers');
2015-10-18 16:35:50 +02:00
end;
procedure TMVCEngine.OnBeforeDispatch(Sender: TObject; Request: TWebRequest;
Response: TWebResponse; var Handled: boolean);
begin
Handled := false;
if Assigned(FSavedOnBeforeDispatch) then
FSavedOnBeforeDispatch(Sender, Request, Response, Handled);
// _Request := Request as TIdHTTPAppRequest;
if not Handled then
begin
try
// "X-Requested-With", "XMLHttpRequest"
Handled := ExecuteAction(Sender, Request, Response); // tristan
except
on E: Exception do
begin
LogException(E);
// Response.ContentStream.Size := 0;
Response.Content := E.Message;
Response.SendResponse;
Handled := true;
end;
end;
// Handled := true;
end;
2013-10-30 00:48:23 +01:00
end;
2015-04-01 17:01:23 +02:00
function TMVCEngine.RegisteredControllers: TList<TMVCControllerClass>;
begin
Result := FControllers;
2015-10-18 16:35:50 +02:00
end;
procedure TMVCEngine.ResponseErrorPage(E: Exception; Request: TWebRequest;
Response: TWebResponse);
begin
Response.SetCustomHeader('x-mvc-error', E.ClassName + ': ' + E.Message);
Response.StatusCode := 200;
if Pos('text/html', LowerCase(Request.Accept)) = 1 then
begin
Response.ContentType := 'text/plain';
Response.Content := 'DelphiMVCFramework ERROR:' + sLineBreak +
'Exception raised of class: ' + E.ClassName + sLineBreak +
'***********************************************' + sLineBreak + E.Message
+ sLineBreak + '***********************************************';
end
else
begin
Response.ContentType := 'text/plain';
Response.Content := 'DelphiMVCFramework ERROR:' + sLineBreak +
'Exception raised of class: ' + E.ClassName + sLineBreak +
'***********************************************' + sLineBreak + E.Message
+ sLineBreak + '***********************************************';
end;
2013-10-30 00:48:23 +01:00
end;
2015-04-01 17:01:23 +02:00
class function TMVCEngine.SendSessionCookie(AContext: TWebContext): string;
var
LSessionID: string;
2015-04-01 17:01:23 +02:00
begin
LSessionID := StringReplace
(StringReplace(StringReplace(GUIDToString(TGUID.NewGuid), '}', '', []), '{',
'', []), '-', '', [rfReplaceAll]);
Result := SendSessionCookie(AContext, LSessionID);
2015-04-01 17:01:23 +02:00
end;
2015-10-18 16:35:50 +02:00
class function TMVCEngine.SendSessionCookie(AContext: TWebContext;
ASessionID: string): string;
2015-04-01 17:01:23 +02:00
var
Cookie: TCookie;
2015-04-01 17:01:23 +02:00
begin
Cookie := AContext.Response.Cookies.Add;
Cookie.Name := TMVCConstants.SESSION_TOKEN_NAME;
Cookie.Value := ASessionID;
Cookie.Expires := now + OneHour * 24 * 365;
// OneMinute * strtoint(GetMVCConfig['sessiontimeout']);
Cookie.Path := '/';
Result := ASessionID;
2015-04-01 17:01:23 +02:00
end;
2013-10-30 00:48:23 +01:00
procedure TMVCEngine.SetApplicationSession(const Value: TWebApplicationSession);
begin
FApplicationSession := Value;
2013-10-30 00:48:23 +01:00
end;
{ TWebContext }
2015-10-18 16:35:50 +02:00
constructor TWebContext.Create(ARequest: TWebRequest; AResponse: TWebResponse;
AConfig: TMVCConfig);
2013-10-30 00:48:23 +01:00
begin
inherited Create;
if IsLibrary then
begin
{$IF CompilerVersion >= 27}
if ARequest is TApacheRequest then
FRequest := TMVCApacheWebRequest.Create(ARequest)
else if ARequest is TISAPIRequest then
FRequest := TMVCISAPIWebRequest.Create(ARequest)
else
raise EMVCException.Create('Unknown request type ' + ARequest.ClassName);
{$ELSE}
FRequest := TMVCISAPIWebRequest.Create(ARequest)
{$ENDIF}
end
else
begin
2013-10-30 00:48:23 +01:00
2013-11-08 23:10:25 +01:00
{$IFDEF IOCP}
FRequest := TMVCIOCPWebRequest.Create(ARequest);
2013-10-30 00:48:23 +01:00
2013-11-08 23:10:25 +01:00
{$ELSE}
FRequest := TMVCINDYWebRequest.Create(ARequest);
2013-11-08 23:10:25 +01:00
{$ENDIF}
end;
FResponse := TMVCWebResponse.Create(AResponse);
FConfig := AConfig;
FData := TDictionary<string, string>.Create;
FLoggedUser := TUser.Create;
2013-10-30 00:48:23 +01:00
end;
destructor TWebContext.Destroy;
begin
FreeAndNil(FResponse);
FreeAndNil(FRequest);
FreeAndNil(FData);
FreeAndNil(FLoggedUser);
inherited;
2013-10-30 00:48:23 +01:00
end;
procedure TWebContext.Flush;
begin
FResponse.Flush;
2013-10-30 00:48:23 +01:00
end;
2014-05-21 17:16:15 +02:00
function TWebContext.GetData: TDictionary<string, string>;
begin
Result := FData;
end;
2015-04-01 17:01:23 +02:00
function TWebContext.GetLoggedUser: TUser;
begin
if not Assigned(FLoggedUser) then
begin
FLoggedUser := TUser.Create;
end;
Result := FLoggedUser;
2015-04-01 17:01:23 +02:00
end;
2013-10-30 00:48:23 +01:00
procedure TWebContext.SetParams(AParamsTable: TMVCRequestParamsTable);
begin
FParamsTable := AParamsTable;
FRequest.FParamsTable := AParamsTable;
2013-10-30 00:48:23 +01:00
end;
{ TMVCWebResponse }
constructor TMVCWebResponse.Create(AWebResponse: TWebResponse);
begin
FStreamOutputDone := false;
FFlushOnDestroy := true;
inherited Create;
FWebResponse := AWebResponse;
2013-10-30 00:48:23 +01:00
end;
destructor TMVCWebResponse.Destroy;
begin
if FFlushOnDestroy then // tristan
Flush;
inherited;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCWebResponse.Flush;
begin
try
FWebResponse.SendResponse; // daniele
except
end;
2013-10-30 00:48:23 +01:00
end;
function TMVCWebResponse.GetContent: string;
begin
Result := FWebResponse.Content;
2013-10-30 00:48:23 +01:00
end;
function TMVCWebResponse.GetContentType: string;
begin
Result := FWebResponse.ContentType;
2013-10-30 00:48:23 +01:00
end;
function TMVCWebResponse.GetCookies: TCookieCollection;
begin
Result := Self.FWebResponse.Cookies;
2013-10-30 00:48:23 +01:00
end;
function TMVCWebResponse.GetCustomHeaders: TStrings;
begin
Result := FWebResponse.CustomHeaders;
2013-10-30 00:48:23 +01:00
end;
2014-05-21 17:16:15 +02:00
function TMVCWebResponse.GetLocation: string;
2014-03-25 12:41:23 +01:00
begin
Result := CustomHeaders.Values['location'];
2014-03-25 12:41:23 +01:00
end;
function TMVCWebResponse.GetReasonString: string;
begin
Result := FWebResponse.ReasonString;
end;
2013-10-30 00:48:23 +01:00
function TMVCWebResponse.GetStatusCode: Integer;
begin
Result := FWebResponse.StatusCode;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCWebResponse.SendHeaders;
begin
FWebResponse.SendResponse
2013-10-30 00:48:23 +01:00
end;
procedure TMVCWebResponse.SetContent(const Value: string);
begin
FWebResponse.Content := Value;
2013-10-30 00:48:23 +01:00
end;
2015-10-18 16:35:50 +02:00
procedure TMVCWebResponse.SetContentStream(AStream: TStream;
AContentType: string);
2013-10-30 00:48:23 +01:00
begin
FWebResponse.ContentType := AContentType;
FWebResponse.ContentStream := AStream;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCWebResponse.SetContentType(const Value: string);
begin
FWebResponse.ContentType := Value;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCWebResponse.SetCustomHeader(const Name, Value: string);
begin
Self.FWebResponse.SetCustomHeader(name, Value);
2013-10-30 00:48:23 +01:00
end;
2014-05-21 17:16:15 +02:00
procedure TMVCWebResponse.SetLocation(const Value: string);
2014-03-25 12:41:23 +01:00
begin
CustomHeaders.Values['location'] := Value;
2014-03-25 12:41:23 +01:00
end;
2013-10-30 00:48:23 +01:00
procedure TMVCWebResponse.SetReasonString(const Value: string);
begin
FWebResponse.ReasonString := Value;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCWebResponse.SetStatusCode(const Value: Integer);
begin
FWebResponse.StatusCode := Value;
2013-10-30 00:48:23 +01:00
end;
{ TMVCWebRequest }
function TMVCWebRequest.Accept: string;
begin
Result := Self.FWebRequest.Accept;
2013-10-30 00:48:23 +01:00
end;
function TMVCWebRequest.Body: string;
{ .$IF CompilerVersion <= 27 }
var
InEnc: TEncoding;
Buffer: TArray<Byte>;
I: Integer;
{ .$ENDIF }
begin
{ .$IF CompilerVersion > 27 }
// Exit(FWebRequest.Content);
{ .$ELSE }
// Property FWebRequest.Content is broken. It doesn't correctly decode the response body
// considering the content charser. So, here's the fix
// check http://msdn.microsoft.com/en-us/library/dd317756(VS.85).aspx
if FCharset.IsEmpty then
begin
SetLength(Buffer, 10);
for I := 0 to 9 do
begin
Buffer[I] := Byte(FWebRequest.RawContent[I]);
end;
TEncoding.GetBufferEncoding(Buffer, InEnc, TEncoding.Default);
SetLength(Buffer, 0);
end
else
InEnc := TEncoding.GetEncoding(FCharset);
try
Buffer := TEncoding.Convert(InEnc, TEncoding.Default,
TBytes(FWebRequest.RawContent));
Result := TEncoding.Default.GetString(Buffer);
finally
InEnc.Free;
end
{ .$ENDIF }
2013-10-30 00:48:23 +01:00
end;
2014-05-21 17:16:15 +02:00
function TMVCWebRequest.BodyAs<T>(const RootProperty: string): T;
var
S: string;
JObj: TJSONObject;
begin
if ContentType.Equals(TMVCMimeType.APPLICATION_JSON) then
begin
if RootProperty = '' then
begin
JObj := BodyAsJSONObject;
if not Assigned(JObj) then
raise EMVCException.Create('Invalid or not present JSON body');
Result := Mapper.JSONObjectToObject<T>(JObj);
end
else
begin
S := Mapper.GetStringDef(BodyAsJSONObject, RootProperty, '');
if not S.IsEmpty then
Result := Mapper.JSONObjectToObject<T>(BodyAsJSONObject.Get(S)
.JsonValue as TJSONObject)
else
raise EMVCException.CreateFmt('Body property %s not valid',
[RootProperty]);
end;
end
else
raise EMVCException.CreateFmt('Body ContentType %s not supported',
[ContentType]);
end;
2013-10-30 00:48:23 +01:00
function TMVCWebRequest.BodyAsJSONObject: TJSONObject;
begin
Result := BodyAsJSONValue as TJSONObject;
end;
function TMVCWebRequest.BodyAsJSONValue: TJSONValue;
begin
if not Assigned(FBodyAsJSONValue) then
try
FBodyAsJSONValue := TJSONObject.ParseJSONValue(Body);
except
FBodyAsJSONValue := nil;
end;
Result := FBodyAsJSONValue;
2013-10-30 00:48:23 +01:00
end;
2015-10-18 16:35:50 +02:00
function TMVCWebRequest.BodyAsListOf<T>(const RootProperty: string)
: TObjectList<T>;
var
S: string;
begin
if ContentType.Equals(TMVCMimeType.APPLICATION_JSON) then
begin
if RootProperty = '' then
Result := Mapper.JSONArrayToObjectList<T>((BodyAsJSONValue as TJSONArray),
false, true)
// Ezequiel J. M<>ller (bug fix)
else
begin
S := Mapper.GetStringDef(BodyAsJSONObject, RootProperty, '');
if not S.IsEmpty then
Result := Mapper.JSONArrayToObjectList<T>(BodyAsJSONObject.Get(S)
.JsonValue as TJSONArray, false, true) // thank you Ezequiel J. M<>ller
else
raise EMVCException.CreateFmt('Body property %s not valid',
[RootProperty]);
end;
end
else
raise EMVCException.CreateFmt('Body ContentType %s not supported',
[ContentType]);
end;
function TMVCWebRequest.ClientIP: string;
{
This code has been converted to Delphi from a PHP code
http://www.grantburton.com/2008/11/30/fix-for-incorrect-ip-addresses-in-wordpress-comments/
}
var
S: string;
begin
if FWebRequest.GetFieldByName('HTTP_CLIENT_IP') <> '' then
Exit(FWebRequest.GetFieldByName('HTTP_CLIENT_IP'));
for S in String(FWebRequest.GetFieldByName('HTTP_X_FORWARDED_FOR'))
.Split([',']) do
begin
if not S.trim.IsEmpty then
Exit(S.trim);
end;
if FWebRequest.GetFieldByName('HTTP_X_FORWARDED') <> '' then
Exit(FWebRequest.GetFieldByName('HTTP_X_FORWARDED'));
if FWebRequest.GetFieldByName('HTTP_X_CLUSTER_CLIENT_IP') <> '' then
Exit(FWebRequest.GetFieldByName('HTTP_X_CLUSTER_CLIENT_IP'));
if FWebRequest.GetFieldByName('HTTP_FORWARDED_FOR') <> '' then
Exit(FWebRequest.GetFieldByName('HTTP_FORWARDED_FOR'));
if FWebRequest.GetFieldByName('HTTP_FORWARDED') <> '' then
Exit(FWebRequest.GetFieldByName('HTTP_FORWARDED'));
if FWebRequest.GetFieldByName('REMOTE_ADDR') <> '' then
Exit(FWebRequest.GetFieldByName('REMOTE_ADDR'));
if FWebRequest.RemoteIP <> '' then
Exit(FWebRequest.RemoteIP);
if FWebRequest.RemoteAddr <> '' then
Exit(FWebRequest.RemoteAddr);
if FWebRequest.RemoteHost <> '' then
Exit(FWebRequest.RemoteHost);
if FWebRequest.RemoteAddr <> '' then
Exit(FWebRequest.RemoteAddr);
if FWebRequest.RemoteIP <> '' then
Exit(FWebRequest.RemoteIP);
if FWebRequest.RemoteHost <> '' then
Exit(FWebRequest.RemoteHost);
Result := '';
end;
2013-10-30 00:48:23 +01:00
function TMVCWebRequest.ClientPrefer(MimeType: string): boolean;
begin
Result := AnsiPos(MimeType, LowerCase(RawWebRequest.Accept)) = 1;
2013-10-30 00:48:23 +01:00
end;
function TMVCWebRequest.ContentParam(Name: string): string;
begin
Result := FWebRequest.ContentFields.Values[name];
2013-10-30 00:48:23 +01:00
end;
function TMVCWebRequest.Cookie(Name: string): string;
begin
Result := FWebRequest.CookieFields.Values[name];
2013-10-30 00:48:23 +01:00
end;
constructor TMVCWebRequest.Create(AWebRequest: TWebRequest);
var
CT: TArray<string>;
c: string;
begin
inherited Create;
c := AWebRequest.GetFieldByName('Content-Type');
if not c.IsEmpty then
begin
CT := c.Split([';']);
FContentType := trim(CT[0]);
FCharset := TMVCConstants.DEFAULT_CONTENT_CHARSET; // default charset
if Length(CT) > 1 then
begin
if CT[1].trim.StartsWith('charset', true) then
begin
FCharset := CT[1].trim.Split(['='])[1].trim;
end;
end;
end;
// c := GetHeaderValue('content-encoding');
// if c.IsEmpty then
// FContentEncoding := c;
end;
2013-10-30 00:48:23 +01:00
destructor TMVCWebRequest.Destroy;
begin
FreeAndNil(FBodyAsJSONValue);
inherited;
2013-10-30 00:48:23 +01:00
end;
{ TMVCAction }
procedure TMVCController.BindToSession(SessionID: string);
begin
if not Assigned(FWebSession) then
begin
FWebSession := TMVCEngine.GetCurrentSession
(StrToInt64(GetMVCConfig[TMVCConfigKey.SessionTimeout]),
SessionID, false);
if not Assigned(FWebSession) then
raise EMVCException.Create('Invalid SessionID');
FWebSession.MarkAsUsed;
TMVCEngine.SendSessionCookie(FContext, SessionID);
end
else
raise EMVCException.Create('Session already bounded for this request');
2013-10-30 00:48:23 +01:00
end;
constructor TMVCController.Create;
begin
inherited Create;
FIsSessionStarted := false;
FSessionMustBeClose := false;
FContentCharset := TMVCConstants.DEFAULT_CONTENT_CHARSET;
2013-10-30 00:48:23 +01:00
end;
destructor TMVCController.Destroy;
begin
FreeAndNil(FResponseStream);
FreeAndNil(FViewDataSets);
FreeAndNil(FViewModel);
inherited;
2013-10-30 00:48:23 +01:00
end;
2015-10-18 16:35:50 +02:00
procedure TMVCController.EnqueueMessageOnTopicOrQueue(const IsQueue: boolean;
const ATopic: string; AJSONObject: TJSONObject; AOwnsInstance: boolean);
2013-10-30 00:48:23 +01:00
var
Stomp: IStompClient;
H: IStompHeaders;
msg: TJSONObject;
begin
msg := TJSONObject.Create;
try
if AOwnsInstance then
msg.AddPair('message', AJSONObject)
else
msg.AddPair('message', AJSONObject.Clone as TJSONObject);
if IsQueue then
msg.AddPair('_queue', ATopic)
else
msg.AddPair('_topic', ATopic);
msg.AddPair('_username', GetClientID).AddPair('_timestamp',
FormatDateTime('YYYY-MM-DD HH:NN:SS', now));
Stomp := GetNewStompClient(GetClientID);
H := StompUtils.NewHeaders.Add(TStompHeaders.NewPersistentHeader(true));
{$IF CompilerVersion >= 28}
Stomp.Send(ATopic, msg.ToJSON);
{$ELSE}
Stomp.Send(ATopic, msg.ToString);
{$ENDIF}
TThread.Sleep(100);
// single user cannot enqueue more than 10 message in noe second...
// it is noot too much elegant, but it works as DoS protection
finally
msg.Free;
end;
2013-10-30 00:48:23 +01:00
end;
2015-04-01 17:01:23 +02:00
function TMVCController.GetClientID: string;
begin
Result := Session[CLIENTID_KEY];
if Result.IsEmpty then
// if Result.IsEmpty then
raise EMVCException.Create('Invalid ClientID' + sLineBreak +
'Hint: Messaging extensions require a valid clientid. Did you call /messages/clients/YOUR_CLIENT_ID ?');
2015-04-01 17:01:23 +02:00
end;
2014-06-27 15:30:39 +02:00
function TMVCController.GetContentCharset: string;
2013-11-05 14:57:50 +01:00
begin
Result := FContentCharset;
2013-11-05 14:57:50 +01:00
end;
2013-10-30 00:48:23 +01:00
function TMVCController.GetContentType: string;
begin
Result := FContext.Response.ContentType;
2013-10-30 00:48:23 +01:00
end;
2013-11-10 01:04:17 +01:00
function TMVCController.GetCurrentWebModule: TWebModule;
begin
Result := GetMVCEngine.Owner as TWebModule;
2013-11-10 01:04:17 +01:00
end;
2013-10-30 00:48:23 +01:00
function TMVCController.GetNewStompClient(ClientID: string): IStompClient;
begin
Result := StompUtils.NewStomp(Config[TMVCConfigKey.StompServer],
StrToInt(Config[TMVCConfigKey.StompServerPort]), GetClientID,
Config[TMVCConfigKey.StompUsername], Config[TMVCConfigKey.StompPassword]);
2013-10-30 00:48:23 +01:00
end;
function TMVCController.GetWebSession: TWebSession;
begin
if not Assigned(FWebSession) then
begin
FWebSession := TMVCEngine.GetCurrentSession
(StrToInt64(GetMVCConfig[TMVCConfigKey.SessionTimeout]),
TMVCEngine.ExtractSessionIDFromWebRequest
(FContext.Request.RawWebRequest), false);
if not Assigned(FWebSession) then
SessionStart
// else
// SendSessionCookie(FWebSession.SessionID); //daniele
end;
Result := FWebSession;
Result.MarkAsUsed;
2015-10-18 16:35:50 +02:00
end;
procedure TMVCController.LoadView(const ViewNames: TArray<String>);
2013-10-30 00:48:23 +01:00
var
View: TMVCMustacheView;
LViewName: String;
begin
for LViewName in ViewNames do
begin
try
View := TMVCMustacheView.Create(LViewName, GetMVCEngine, FContext,
FViewModel, FViewDataSets, ContentType);
try
View.SetMVCConfig(GetMVCConfig);
View.Execute;
ResponseStream.Append(View.GetOutput);
finally
View.Free;
end;
except
on E: Exception do
begin
ContentType := 'text/plain';
Render(E);
end;
end;
end;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCController.MVCControllerAfterCreate;
begin
inherited;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCController.MVCControllerBeforeDestroy;
begin
inherited;
2013-10-30 00:48:23 +01:00
end;
2015-10-18 16:35:50 +02:00
procedure TMVCController.OnAfterAction(Context: TWebContext;
const AActionNAme: string);
2013-10-30 00:48:23 +01:00
begin
// do nothing
2013-10-30 00:48:23 +01:00
end;
2015-10-18 16:35:50 +02:00
procedure TMVCController.OnBeforeAction(Context: TWebContext;
const AActionNAme: string; var Handled: boolean);
2013-10-30 00:48:23 +01:00
begin
Handled := false;
if ContentType.IsEmpty then
ContentType := GetMVCConfig[TMVCConfigKey.DefaultContentType];
2013-10-30 00:48:23 +01:00
end;
2015-10-18 16:35:50 +02:00
procedure TMVCController.PushDataSetToView(const AModelName: string;
ADataSet: TDataSet);
2015-10-18 16:35:50 +02:00
var
LJArr: TJSONArray;
2013-10-30 00:48:23 +01:00
begin
LJArr := TJSONArray.Create;
try
Mapper.DataSetToJSONArray(ADataSet, LJArr, true);
except
LJArr.Free;
raise;
end;
PushJSONToView(AModelName, LJArr);
2013-10-30 00:48:23 +01:00
end;
2015-10-18 16:35:50 +02:00
procedure TMVCController.PushJSONToView(const AModelName: string;
AModel: TJSONValue);
2013-10-30 00:48:23 +01:00
begin
if not Assigned(FViewModel) then
FViewModel := TMVCDataObjects.Create;
FViewModel.Add(AModelName, AModel);
2013-10-30 00:48:23 +01:00
end;
2015-10-18 16:35:50 +02:00
procedure TMVCController.PushObjectToView(const AModelName: string;
AModel: TObject);
2013-10-30 00:48:23 +01:00
begin
PushJSONToView(AModelName, Mapper.ObjectToJSONObject(AModel));
2013-10-30 00:48:23 +01:00
end;
2015-10-18 16:35:50 +02:00
procedure InternalRenderText(const AContent: string;
ContentType, ContentEncoding: string; Context: TWebContext);
2014-04-01 00:02:31 +02:00
var
OutEncoding: TEncoding;
begin
OutEncoding := TEncoding.GetEncoding(ContentEncoding);
try
// Context.Response.RawWebResponse.ContentStream := TStringStream.Create(UTF8Encode(AContent));
if SameText('UTF-8', ContentEncoding) then
begin
Context.Response.RawWebResponse.Content := '';
Context.Response.RawWebResponse.ContentStream :=
TStringStream.Create(UTF8Encode(AContent));
end
else
begin
Context.Response.RawWebResponse.Content :=
OutEncoding.GetString(TEncoding.Convert(TEncoding.UTF8, OutEncoding,
TEncoding.Default.GetBytes(AContent)));
end;
finally
OutEncoding.Free;
end;
Context.Response.RawWebResponse.ContentType := ContentType + '; charset=' +
ContentEncoding;
// Context.Response.RawWebResponse.ContentType := TMVCMimeType.APPLICATION_JSON;
// Context.Response.RawWebResponse.ContentEncoding := ContentEncoding;
// OutEncoding := TEncoding.GetEncoding(ContentEncoding);
// InEncoding := TEncoding.Default; // GetEncoding(S);
// Context.Response.Content := OutEncoding.GetString
// (TEncoding.Convert(InEncoding, OutEncoding, InEncoding.GetBytes(AContent)));
// OutEncoding.Free;
2015-10-18 16:35:50 +02:00
end;
procedure InternalRender(AJSONValue: TJSONValue;
ContentType, ContentEncoding: string; Context: TWebContext;
AInstanceOwner: boolean);
2013-12-04 13:06:18 +01:00
var
OutEncoding: TEncoding;
JString: string;
2013-12-04 13:06:18 +01:00
begin
2015-01-14 14:13:48 +01:00
{$IF CompilerVersion <= 27}
JString := AJSONValue.ToString; // requires the patch
2015-01-14 14:13:48 +01:00
{$ELSE}
JString := AJSONValue.ToJSON; // since XE7 it works using ToJSON
2015-01-14 14:13:48 +01:00
{$ENDIF}
OutEncoding := TEncoding.GetEncoding(ContentEncoding);
try
Context.Response.RawWebResponse.Content :=
OutEncoding.GetString(TEncoding.Convert(TEncoding.Default, OutEncoding,
TEncoding.Default.GetBytes(JString)));
finally
OutEncoding.Free;
end;
Context.Response.RawWebResponse.ContentType := ContentType + '; charset=' +
ContentEncoding;
// Context.Response.RawWebResponse.StatusCode := 200;
{
Context.Response.RawWebResponse.ContentType := TMVCMimeType.APPLICATION_JSON;
//Context.Response.RawWebResponse.ContentEncoding := ContentEncoding;
S := AJSONValue.ToString;
OutEncoding := TEncoding.GetEncoding(ContentEncoding);
InEncoding := TEncoding.Default;
Context.Response.RawWebResponse.Content := OutEncoding.GetString
(TEncoding.Convert(InEncoding, OutEncoding, InEncoding.GetBytes(S)));
OutEncoding.Free;
Context.Response.RawWebResponse.Content := s;
}
if AInstanceOwner then
FreeAndNil(AJSONValue)
2015-10-18 16:35:50 +02:00
end;
procedure InternalRender(const Content: string;
ContentType, ContentEncoding: string; Context: TWebContext);
begin
if ContentType = TMVCMimeType.APPLICATION_JSON then
begin
InternalRender(TJSONString.Create(Content), ContentType, ContentEncoding,
Context, true);
end
else if ContentType = TMVCMimeType.TEXT_XML then
begin
raise EMVCException.Create('Format still not supported - ' + ContentType);
end
else
begin
if ContentType.IsEmpty then
InternalRenderText(Content, 'text/plain', ContentEncoding, Context)
else
InternalRenderText(Content, ContentType, ContentEncoding, Context);
end;
2013-10-30 00:48:23 +01:00
end;
2014-04-16 22:52:25 +02:00
procedure TMVCController.Render(const Content: string);
2013-12-04 13:06:18 +01:00
begin
InternalRender(Content, ContentType, ContentCharset, Context);
2013-12-04 13:06:18 +01:00
end;
2015-04-01 17:01:23 +02:00
procedure TMVCController.Render(AObject: TObject; AInstanceOwner: boolean;
ASerializationType: TDMVCSerializationType);
2013-10-30 00:48:23 +01:00
var
JSON: TJSONObject;
2013-10-30 00:48:23 +01:00
begin
if ASerializationType = TDMVCSerializationType.Properties then
JSON := Mapper.ObjectToJSONObject(AObject)
else
JSON := Mapper.ObjectToJSONObjectFields(AObject, []);
Render(JSON, true);
if AInstanceOwner then
FreeAndNil(AObject);
2013-10-30 00:48:23 +01:00
end;
procedure TMVCController.SendFile(AFileName: string);
begin
TMVCStaticContents.SendFile(AFileName, ContentType, Context);
2013-10-30 00:48:23 +01:00
end;
2015-04-01 17:01:23 +02:00
function TMVCController.SendSessionCookie(AContext: TWebContext): string;
2013-10-30 00:48:23 +01:00
begin
Result := TMVCEngine.SendSessionCookie(AContext);
2013-10-30 00:48:23 +01:00
end;
2015-06-29 14:36:54 +02:00
procedure TMVCController.SendStream(AStream: TStream; AOwnStream: boolean);
2013-10-30 00:48:23 +01:00
begin
FContext.Response.FWebResponse.Content := '';
// FContext.Response.SetContentStream(AStream, ContentType);
FContext.Response.FWebResponse.ContentType := ContentType;
FContext.Response.FWebResponse.ContentStream := AStream;
FContext.Response.FWebResponse.FreeContentStream := AOwnStream;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCController.SessionStart;
var
LSessionID: string;
2013-10-30 00:48:23 +01:00
begin
if not Assigned(FWebSession) then
begin
LSessionID := TMVCEngine.SendSessionCookie(FContext);
FWebSession := TMVCEngine.AddSessionToTheSessionList(LSessionID,
StrToInt64(Config[TMVCConfigKey.SessionTimeout]));
FIsSessionStarted := true;
FSessionMustBeClose := false;
end;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCController.SessionStop(ARaiseExceptionIfExpired: boolean);
var
Cookie: TCookie;
begin
// Set-Cookie: token=deleted; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT
FContext.FResponse.Cookies.Clear; // daniele ... remove all previous cookies
Cookie := FContext.FResponse.Cookies.Add;
Cookie.Name := TMVCConstants.SESSION_TOKEN_NAME;
// rubbish... invalid the cookie value
Cookie.Value := GUIDToString(TGUID.NewGuid) + 'invalid' +
GUIDToString(TGUID.NewGuid);
Cookie.Expires := EncodeDate(1970, 1, 1);
Cookie.Path := '/';
TMonitor.Enter(SessionList);
try
if not Assigned(FWebSession) then
FWebSession := TMVCEngine.GetCurrentSession
(StrToInt64(GetMVCConfig[TMVCConfigKey.SessionTimeout]), '',
ARaiseExceptionIfExpired);
if Assigned(FWebSession) then
SessionList.Remove(Session.SessionID);
finally
TMonitor.Exit(SessionList);
end;
FIsSessionStarted := false;
FSessionMustBeClose := true;
2013-10-30 00:48:23 +01:00
end;
2014-06-27 15:30:39 +02:00
procedure TMVCController.SetContentCharset(const Value: string);
2013-11-05 14:57:50 +01:00
begin
FContentCharset := Value;
2013-11-05 14:57:50 +01:00
end;
2014-04-16 22:52:25 +02:00
procedure TMVCController.SetContentType(const Value: string);
2013-10-30 00:48:23 +01:00
begin
FContext.Response.ContentType := Value;
2013-10-30 00:48:23 +01:00
end;
2014-04-16 22:52:25 +02:00
procedure TMVCController.SetContext(const Value: TWebContext);
2013-10-30 00:48:23 +01:00
begin
if FContext = nil then
FContext := Value
else
raise EMVCException.Create('Context already set');
2013-10-30 00:48:23 +01:00
end;
// procedure TMVCController.SetViewCache(const Value: TViewCache);
// begin
// FViewCache := Value;
// end;
2014-04-16 22:52:25 +02:00
procedure TMVCController.SetWebSession(const Value: TWebSession);
2013-10-30 00:48:23 +01:00
begin
if Assigned(FWebSession) then
raise EMVCException.Create('Web Session already set for controller ' +
ClassName);
FWebSession := Value;
FIsSessionStarted := Assigned(FWebSession);
2013-10-30 00:48:23 +01:00
end;
{ TMVCPathAttribute }
2014-04-16 22:52:25 +02:00
constructor MVCPathAttribute.Create(const Value: string);
2013-10-30 00:48:23 +01:00
begin
inherited Create;
FPath := Value;
2013-10-30 00:48:23 +01:00
end;
function TMVCWebRequest.QueryStringParam(Name: string): string;
begin
Result := FWebRequest.QueryFields.Values[name];
2013-10-30 00:48:23 +01:00
end;
2013-11-08 23:10:25 +01:00
function TMVCWebRequest.QueryStringParamExists(Name: string): boolean;
begin
Result := not QueryStringParam(name).IsEmpty;
2013-11-08 23:10:25 +01:00
end;
2013-10-30 00:48:23 +01:00
function TMVCWebRequest.GetClientPreferHTML: boolean;
begin
Result := ClientPrefer(TMVCMimeType.TEXT_HTML);
2013-10-30 00:48:23 +01:00
end;
function TMVCWebRequest.GetFiles: TAbstractWebRequestFiles;
begin
Result := FWebRequest.Files;
2013-10-30 00:48:23 +01:00
end;
2014-04-16 22:52:25 +02:00
function TMVCWebRequest.GetHeader(const Name: string): string;
2014-04-10 13:56:23 +02:00
begin
if Assigned(FWebRequest) then
Result := FWebRequest.GetFieldByName(name)
else
Result := '';
2014-04-10 13:56:23 +02:00
end;
2015-04-01 17:01:23 +02:00
// function TMVCWebRequest.GetHeaderValue(const Name: string): string;
// var
// S: string;
// begin
// S := GetHeader(name);
// if S.IsEmpty then
// Result := ''
// else
// Result := S.Split([':'])[1].trim;
// end;
2013-10-30 00:48:23 +01:00
// function TMVCWebRequest.GetHeaderAll(const HeaderName: string): string;
// begin
// Result := Self.FWebRequest.GetFieldByName(HeaderName);
// end;
function TMVCWebRequest.GetHTTPMethod: TMVCHTTPMethodType;
begin
Result := TMVCRouter.StringMethodToHTTPMetod(FWebRequest.Method);
2013-10-30 00:48:23 +01:00
end;
function TMVCWebRequest.GetHTTPMethodAsString: string;
begin
Result := FWebRequest.Method;
2013-10-30 00:48:23 +01:00
end;
function TMVCWebRequest.GetIsAjax: boolean;
begin
Result := LowerCase(FWebRequest.GetFieldByName('X-Requested-With'))
= 'xmlhttprequest';
2013-10-30 00:48:23 +01:00
end;
2014-04-16 22:52:25 +02:00
function TMVCWebRequest.GetParamAll(const ParamName: string): string;
2013-10-30 00:48:23 +01:00
begin
if (not Assigned(FParamsTable)) or
(not FParamsTable.TryGetValue(ParamName, Result)) then
begin
Result := FWebRequest.QueryFields.Values[ParamName];
if Result = EmptyStr then
Result := FWebRequest.ContentFields.Values[ParamName];
if Result = EmptyStr then
Result := FWebRequest.CookieFields.Values[ParamName];
end;
2013-10-30 00:48:23 +01:00
end;
2014-04-16 22:52:25 +02:00
function TMVCWebRequest.GetParamAllAsInteger(const ParamName: string): Integer;
2013-10-30 00:48:23 +01:00
begin
Result := StrToInt(GetParamAll(ParamName));
2013-10-30 00:48:23 +01:00
end;
2014-05-21 17:16:15 +02:00
function TMVCWebRequest.GetParamNames: TArray<string>;
2013-11-12 01:23:50 +01:00
var
I: Integer;
Names: TList<string>;
n: string;
2013-11-12 01:23:50 +01:00
begin
if Length(FParamNames) > 0 then
Exit(FParamNames);
2013-11-12 01:23:50 +01:00
Names := TList<string>.Create;
try
if Assigned(FParamsTable) and (Length(FParamsTable.Keys.ToArray) > 0) then
for n in FParamsTable.Keys.ToArray do
Names.Add(n);
2013-11-12 01:23:50 +01:00
if FWebRequest.QueryFields.Count > 0 then
for I := 0 to FWebRequest.QueryFields.Count - 1 do
Names.Add(FWebRequest.QueryFields.Names[I]);
2013-11-12 01:23:50 +01:00
if FWebRequest.ContentFields.Count > 0 then
for I := 0 to FWebRequest.ContentFields.Count - 1 do
Names.Add(FWebRequest.ContentFields.Names[I]);
2013-11-12 01:23:50 +01:00
if FWebRequest.CookieFields.Count > 0 then
for I := 0 to FWebRequest.CookieFields.Count - 1 do
Names.Add(FWebRequest.CookieFields.Names[I]);
Result := Names.ToArray;
finally
Names.Free;
end;
2013-11-12 01:23:50 +01:00
end;
2013-10-30 00:48:23 +01:00
function TMVCWebRequest.GetPathInfo: string;
begin
Result := FWebRequest.PathInfo;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCWebRequest.SetParamsTable(AParamsTable: TMVCRequestParamsTable);
begin
FParamsTable := AParamsTable;
2013-10-30 00:48:23 +01:00
end;
function TMVCWebRequest.ThereIsRequestBody: boolean;
begin
Result := FWebRequest.Content <> '';
2013-10-30 00:48:23 +01:00
end;
{ MVCHTTPMethodAttribute }
constructor MVCHTTPMethodAttribute.Create(AMVCHTTPMethods: TMVCHTTPMethods);
begin
inherited Create;
FMVCHTTPMethods := AMVCHTTPMethods;
2013-10-30 00:48:23 +01:00
end;
function MVCHTTPMethodAttribute.GetMVCHTTPMethodsAsString: string;
var
I: TMVCHTTPMethodType;
2013-10-30 00:48:23 +01:00
begin
Result := '';
for I := low(TMVCHTTPMethodType) to high(TMVCHTTPMethodType) do
begin
if I in FMVCHTTPMethods then
begin
Result := Result + ',' + GetEnumName
(TypeInfo(TMVCHTTPMethodType), Ord(I));
end;
end;
2013-10-30 00:48:23 +01:00
if not Result.IsEmpty then
Result := Result.Remove(0, 1)
else
Result := 'any';
2013-10-30 00:48:23 +01:00
end;
{ TMVCStaticContents }
2015-10-18 16:35:50 +02:00
class procedure TMVCStaticContents.SendFile(AFileName, AMimeType: string;
Context: TWebContext);
2013-10-30 00:48:23 +01:00
var
LFileDate: TDateTime;
LReqDate: TDateTime;
S: TFileStream;
begin
LFileDate := IndyFileAge(AFileName);
if (LFileDate = 0.0) and (not FileExists(AFileName)) then
begin
Context.Response.StatusCode := 404;
end
else
begin
LReqDate := GMTToLocalDateTime(Context.Request.Headers
['If-Modified-Since']);
if (LReqDate <> 0) and (abs(LReqDate - LFileDate) < 2 * (1 / (24 * 60 * 60)))
then
begin
Context.Response.ContentType := AMimeType;
Context.Response.StatusCode := 304;
end
else
begin
S := TFileStream.Create(AFileName, fmOpenRead or fmShareDenyNone);
Context.Response.SetCustomHeader('Content-Length', IntToStr(S.Size));
Context.Response.SetCustomHeader('Last-Modified',
LocalDateTimeToHttpStr(LFileDate));
Context.Response.SetContentStream(S, AMimeType);
end;
end;
2013-10-30 00:48:23 +01:00
end;
2015-04-01 17:01:23 +02:00
class function TMVCStaticContents.IsScriptableFile(StaticFileName: string;
Config: TMVCConfig): boolean;
2013-10-30 00:48:23 +01:00
begin
Result := TPath.GetExtension(StaticFileName).ToLower = '.' +
Config[TMVCConfigKey.DefaultViewFileExtension].ToLower;
2013-10-30 00:48:23 +01:00
end;
2015-10-18 16:35:50 +02:00
class function TMVCStaticContents.IsStaticFile(AViewPath, AWebRequestPath
: string; out ARealFileName: string): boolean;
2013-10-30 00:48:23 +01:00
var
FileName: string;
2013-10-30 00:48:23 +01:00
begin
if TDirectory.Exists(AViewPath) then // absolute path
FileName := AViewPath + AWebRequestPath.Replace('/',
TPath.DirectorySeparatorChar)
else
FileName := GetApplicationFileNamePath + AViewPath +
// relative path
AWebRequestPath.Replace('/', TPath.DirectorySeparatorChar);
Result := TFile.Exists(FileName);
ARealFileName := FileName;
2013-10-30 00:48:23 +01:00
end;
2014-04-16 22:52:25 +02:00
procedure TMVCBase.SetApplicationSession(const Value: TWebApplicationSession);
2013-10-30 00:48:23 +01:00
begin
if Assigned(FApplicationSession) then
raise EMVCException.Create('Application Session already set');
FApplicationSession := Value;
2013-10-30 00:48:23 +01:00
end;
2014-04-16 22:52:25 +02:00
procedure TMVCBase.SetMVCConfig(const Value: TMVCConfig);
2013-10-30 00:48:23 +01:00
begin
FMVCConfig := Value;
2013-10-30 00:48:23 +01:00
end;
2014-04-16 22:52:25 +02:00
procedure TMVCBase.SetMVCEngine(const Value: TMVCEngine);
2013-10-30 00:48:23 +01:00
begin
FMVCEngine := Value;
2013-10-30 00:48:23 +01:00
end;
2014-09-05 12:47:40 +02:00
class function TMVCBase.GetApplicationFileName: string;
2013-10-30 00:48:23 +01:00
var
fname: PChar;
Size: Integer;
2013-10-30 00:48:23 +01:00
begin
Result := '';
fname := GetMemory(2048);
try
Size := GetModuleFileName(0, fname, 2048);
if Size > 0 then
Result := fname;
finally
FreeMem(fname, 2048);
end;
2013-10-30 00:48:23 +01:00
end;
2014-09-05 12:47:40 +02:00
class function TMVCBase.GetApplicationFileNamePath: string;
2013-10-30 00:48:23 +01:00
begin
Result := IncludeTrailingPathDelimiter
(ExtractFilePath(GetApplicationFileName));
2013-10-30 00:48:23 +01:00
end;
function TMVCBase.GetMVCConfig: TMVCConfig;
begin
if not Assigned(FMVCConfig) then
EMVCConfigException.Create('MVCConfig not assigned to this ' + ClassName +
' instances');
Result := FMVCConfig;
2013-10-30 00:48:23 +01:00
end;
function TMVCBase.GetMVCEngine: TMVCEngine;
begin
Result := FMVCEngine;
2013-10-30 00:48:23 +01:00
end;
{ TMVCISAPIWebRequest }
constructor TMVCISAPIWebRequest.Create(AWebRequest: TWebRequest);
begin
inherited;
FWebRequest := AWebRequest as TISAPIRequest;
2013-10-30 00:48:23 +01:00
end;
{ TMVCApacheWebRequest }
{$IF CompilerVersion >= 27}
constructor TMVCApacheWebRequest.Create(AWebRequest: TWebRequest);
begin
inherited;
FWebRequest := AWebRequest as TApacheRequest;
end;
{$ENDIF}
2013-10-30 00:48:23 +01:00
{ TMVCINDYWebRequest }
constructor TMVCINDYWebRequest.Create(AWebRequest: TWebRequest);
begin
inherited;
FWebRequest := AWebRequest; // as TIdHTTPAppRequest;
2013-10-30 00:48:23 +01:00
end;
{ TWebSession }
procedure TMVCController.RaiseSessionExpired;
begin
raise EMVCSessionExpiredException.Create('Session expired');
end;
2015-10-18 16:35:50 +02:00
function TMVCController.ReceiveMessageFromTopic(const ATopic: string;
ATimeout: Int64; var JSONObject: TJSONObject): boolean;
2013-10-30 00:48:23 +01:00
var
Stomp: IStompClient;
frame: IStompFrame;
o: TJSONValue;
begin
Result := false;
Stomp := GetNewStompClient(GetClientID);
if not Stomp.Receive(frame, ATimeout) then
JSONObject := nil
else
begin
o := TJSONObject.ParseJSONValue(frame.GetBody);
if not Assigned(o) then
raise EMVCException.Create('Message is not a valid JSONObject')
else
begin
if not(o is TJSONObject) then
begin
FreeAndNil(o);
raise EMVCException.Create
('Message is a JSONValue but not a JSONObject')
end
else
JSONObject := TJSONObject(o);
end;
end;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCController.Redirect(const URL: string);
begin
FContext.Response.FWebResponse.SendRedirect(URL);
2013-10-30 00:48:23 +01:00
end;
2014-04-16 22:52:25 +02:00
procedure TMVCController.Render(E: Exception; ErrorItems: TList<string>);
2013-10-30 00:48:23 +01:00
var
j: TJSONObject;
S: string;
jarr: TJSONArray;
begin
if E is EMVCException then
ResponseStatusCode(EMVCException(E).HTTPErrorCode,
E.Message + ' [' + E.ClassName + ']')
else
begin
if Context.Response.StatusCode = 200 then
ResponseStatusCode(500, E.Message + ' [' + E.ClassName + ']');
end;
if (not Context.Request.IsAjax) and (Context.Request.ClientPreferHTML) then
begin
ContentType := TMVCMimeType.TEXT_HTML;
ContentCharset := TMVCConstants.DEFAULT_CONTENT_CHARSET;
ResponseStream.Clear;
ResponseStream.Append
('<html><head><style>pre { color: #000000; background-color: #d0d0d0; }</style></head><body>')
.Append('<h1>DMVCFramework: Error Raised</h1>')
.AppendFormat('<pre>HTTP Return Code: %d' + sLineBreak,
[Context.Response.StatusCode])
.AppendFormat('HTTP Reason Text: "%s"</pre>',
[Context.Response.ReasonString]).Append('<h3><pre>')
.AppendFormat('Exception Class Name : %s' + sLineBreak, [E.ClassName])
.AppendFormat('Exception Message : %s' + sLineBreak, [E.Message])
.Append('</pre></h3>');
if Assigned(ErrorItems) and (ErrorItems.Count > 0) then
begin
ResponseStream.Append('<h2><pre>');
for S in ErrorItems do
ResponseStream.AppendLine('- ' + S);
ResponseStream.Append('</pre><h2>');
end
else
begin
ResponseStream.AppendLine('<pre>No other informations available</pre>');
end;
ResponseStream.Append('</body></html>');
Render;
end
else if Context.Request.IsAjax or (ContentType = 'application/json') then
begin
j := TJSONObject.Create;
j.AddPair('status', 'error');
j.AddPair('classname', E.ClassName);
j.AddPair('message', E.Message);
j.AddPair('http_error', TJSONNumber.Create(Context.Response.StatusCode));
if Assigned(ErrorItems) then
begin
jarr := TJSONArray.Create;
j.AddPair('erroritems', jarr);
for S in ErrorItems do
begin
jarr.AddElement(TJSONString.Create(S));
end;
end;
Render(j);
end
else
begin
Render(Format('Exception: [%s] %s', [E.ClassName, E.Message]));
end;
2015-10-18 16:35:50 +02:00
end;
procedure TMVCController.Render(const AErrorCode: UInt16;
const AErrorMessage: string; const AErrorClassName: string = '');
2013-10-30 00:48:23 +01:00
var
j: TJSONObject;
status: string;
begin
ResponseStatusCode(AErrorCode, AErrorMessage);
if Context.Request.IsAjax or (ContentType = 'application/json') then
begin
status := 'error';
if (AErrorCode div 100) = 2 then
status := 'ok';
j := TJSONObject.Create;
j.AddPair('status', status);
if AErrorClassName = '' then
j.AddPair('classname', TJSONNull.Create)
else
j.AddPair('classname', AErrorClassName);
j.AddPair('message', AErrorMessage);
Render(j);
end
else
begin
Render(Format('Error: [%d] %s', [AErrorCode, AErrorMessage]));
end;
2013-10-30 00:48:23 +01:00
end;
2015-04-01 17:01:23 +02:00
procedure TMVCController.Render(ADataSet: TDataSet; AInstanceOwner: boolean;
AOnlySingleRecord: boolean; AJSONObjectActionProc: TJSONObjectActionProc);
2013-11-10 01:04:17 +01:00
var
arr: TJSONArray;
JObj: TJSONObject;
begin
if ContentType = TMVCMimeType.APPLICATION_JSON then
begin
if not AOnlySingleRecord then
begin
ADataSet.First;
arr := TJSONArray.Create;
Mapper.DataSetToJSONArray(ADataSet, arr, AInstanceOwner,
AJSONObjectActionProc);
Render(arr);
end
else
begin
JObj := TJSONObject.Create;
Mapper.DataSetToJSONObject(ADataSet, JObj, AInstanceOwner,
AJSONObjectActionProc);
Render(JObj);
end;
end
else
raise Exception.Create('ContentType not supported for this render [' +
ContentType + ']');
// if ContentType = TMVCMimeType.TEXT_XML then
// begin
// Mapper.DataSetToXML(ADataSet, S, AInstanceOwner);
// Render(S);
// end;
2015-10-18 16:35:50 +02:00
end;
procedure TMVCController.Render(const AStream: TStream;
AInstanceOwner: boolean);
2015-10-18 16:35:50 +02:00
begin
SendStream(AStream, AInstanceOwner);
2015-10-18 16:35:50 +02:00
end;
procedure TMVCController.Render<T>(ACollection: TObjectList<T>;
AInstanceOwner: boolean; AJSONObjectActionProc: TJSONObjectActionProc;
ASerializationType: TSerializationType);
2013-10-30 00:48:23 +01:00
var
JSON: TJSONArray;
2013-10-30 00:48:23 +01:00
begin
if ASerializationType = TSerializationType.Properties then
JSON := Mapper.ObjectListToJSONArray<T>(ACollection, false,
AJSONObjectActionProc)
else
JSON := Mapper.ObjectListToJSONArrayFields<T>(ACollection, false,
AJSONObjectActionProc);
Render(JSON, true);
if AInstanceOwner then
FreeAndNil(ACollection);
2013-10-30 00:48:23 +01:00
end;
2015-04-01 17:01:23 +02:00
procedure TMVCController.RenderListAsProperty<T>(const APropertyName: string;
AObjectList: TObjectList<T>; AOwnsInstance: boolean;
AJSONObjectActionProc: TJSONObjectActionProc);
2013-10-30 00:48:23 +01:00
begin
Render(TJSONObject.Create(TJSONPair.Create(APropertyName,
Mapper.ObjectListToJSONArray<T>(AObjectList, AOwnsInstance,
AJSONObjectActionProc))));
2013-10-30 00:48:23 +01:00
end;
2014-04-15 17:03:47 +02:00
procedure TMVCController.RenderStreamAndFree(const AStream: TStream);
begin
SendStream(AStream);
2014-04-15 17:03:47 +02:00
end;
2015-10-18 16:35:50 +02:00
procedure TMVCController.Render(AJSONValue: TJSONValue;
AInstanceOwner: boolean);
2013-12-04 13:06:18 +01:00
begin
InternalRender(AJSONValue, ContentType, ContentCharset, Context,
AInstanceOwner);
2013-10-30 00:48:23 +01:00
end;
2015-10-18 16:35:50 +02:00
procedure TMVCController.ResponseStatusCode(const AStatusCode: UInt16;
AStatusText: string);
2013-10-30 00:48:23 +01:00
begin
Context.Response.StatusCode := AStatusCode;
Context.Response.ReasonString := AStatusText;
2013-10-30 00:48:23 +01:00
end;
function TMVCController.ResponseStream: TStringBuilder;
begin
if not Assigned(FResponseStream) then
FResponseStream := TStringBuilder.Create;
Result := FResponseStream;
2013-10-30 00:48:23 +01:00
end;
constructor MVCPathAttribute.Create;
begin
Create('');
2013-10-30 00:48:23 +01:00
end;
procedure TMVCController.Render(const AErrorCode: UInt16;
AJSONValue: TJSONValue; AInstanceOwner: boolean);
2013-10-30 00:48:23 +01:00
begin
ResponseStatusCode(AErrorCode);
if ContentType = 'application/json' then
begin
Render(AJSONValue, AInstanceOwner);
end
else
begin
raise EMVCException.Create
('Cannot render a JSONValue if ContentType is not application/json');
end;
2013-10-30 00:48:23 +01:00
end;
2015-04-01 17:01:23 +02:00
procedure TMVCController.Render(const AErrorCode: UInt16; AObject: TObject;
AInstanceOwner: boolean);
2013-10-30 00:48:23 +01:00
begin
Render(AErrorCode, Mapper.ObjectToJSONObject(AObject), true);
if AInstanceOwner then
AObject.Free;
2013-10-30 00:48:23 +01:00
end;
procedure TMVCController.Render;
begin
Render(ResponseStream.ToString);
2013-10-30 00:48:23 +01:00
end;
{$IFDEF IOCP}
constructor TMVCIOCPWebRequest.Create(AWebRequest: TWebRequest);
begin
inherited;
FWebRequest := AWebRequest as TIocpWebRequest;
2013-10-30 00:48:23 +01:00
end;
{$ENDIF}
{ MVCStringAttribute }
2014-04-16 22:52:25 +02:00
constructor MVCStringAttribute.Create(const Value: string);
2013-10-30 00:48:23 +01:00
begin
inherited Create;
FValue := Value;
2013-10-30 00:48:23 +01:00
end;
function IsShuttingDown: boolean;
begin
Result := TInterlocked.Read(_IsShuttingDown) = 1
2013-10-30 00:48:23 +01:00
end;
procedure EnterInShutdownState;
begin
TInterlocked.Add(_IsShuttingDown, 1);
2013-10-30 00:48:23 +01:00
end;
2013-11-08 23:10:25 +01:00
{ MVCProduceAttribute }
2014-05-21 17:16:15 +02:00
constructor MVCProducesAttribute.Create(const Value, ProduceEncoding: string);
2013-11-08 23:10:25 +01:00
begin
Create(Value);
FProduceEncoding := ProduceEncoding;
2013-11-08 23:10:25 +01:00
end;
2014-04-16 22:52:25 +02:00
constructor MVCProducesAttribute.Create(const Value: string);
2013-11-08 23:10:25 +01:00
begin
inherited;
FProduceEncoding := 'UTF-8';
2013-11-08 23:10:25 +01:00
end;
2014-05-21 17:16:15 +02:00
procedure MVCProducesAttribute.SetProduceEncoding(const Value: string);
2013-11-08 23:10:25 +01:00
begin
FProduceEncoding := Value;
2013-11-08 23:10:25 +01:00
end;
2015-04-01 17:01:23 +02:00
{ TUser }
procedure TUser.Clear;
begin
FUserName := '';
FLoggedSince := 0;
FRealm := '';
FRoles.Clear;
2015-04-01 17:01:23 +02:00
end;
constructor TUser.Create;
begin
inherited;
FRoles := TList<string>.Create;
Clear;
2015-04-01 17:01:23 +02:00
end;
destructor TUser.Destroy;
begin
FRoles.Free;
inherited;
2015-04-01 17:01:23 +02:00
end;
function TUser.GetIsValidLoggedUser: boolean;
begin
Result := (not UserName.IsEmpty) and (LoggedSince > 0);
2015-04-01 17:01:23 +02:00
end;
function TUser.LoadFromSession(AWebSession: TWebSession): boolean;
var
LSerObj: string;
LPieces: TArray<string>;
I: Integer;
begin
if not Assigned(AWebSession) then
Exit(false);
LSerObj := AWebSession[TMVCConstants.CURRENT_USER_SESSION_KEY];
Result := not LSerObj.IsEmpty;
if Result then
begin
Clear;
LPieces := LSerObj.Split(['$$'], TStringSplitOptions.None);
UserName := LPieces[0];
LoggedSince := ISOStrToDateTime(LPieces[1]);
Realm := LPieces[2];
Roles.Clear;
for I := 2 to Length(LPieces) - 1 do
begin
Roles.Add(LPieces[I]);
end;
end;
2015-04-01 17:01:23 +02:00
end;
procedure TUser.SaveToSession(AWebSession: TWebSession);
var
LRoles: string;
2015-04-01 17:01:23 +02:00
begin
if FRoles.Count > 0 then // bug in string.Join
LRoles := string.Join('$$', FRoles.ToArray)
else
LRoles := '';
AWebSession[TMVCConstants.CURRENT_USER_SESSION_KEY] := FUserName + '$$' +
ISODateTimeToString(FLoggedSince) + '$$' + FRealm + '$$' + LRoles;
2015-04-01 17:01:23 +02:00
end;
procedure TUser.SetLoggedSince(const Value: TDateTime);
begin
if FLoggedSince = 0 then
FLoggedSince := Value
else
raise EMVCException.Create('User.LoggedSince already set');
2015-04-01 17:01:23 +02:00
end;
procedure TUser.SetRealm(const Value: string);
begin
FRealm := Value;
2015-04-01 17:01:23 +02:00
end;
procedure TUser.SetUserName(const Value: string);
begin
FUserName := Value;
2015-04-01 17:01:23 +02:00
end;
2013-10-30 00:48:23 +01:00
initialization
_IsShuttingDown := 0;
end.