Engine.icl 11 KB
Newer Older
1
implementation module iTasks.Engine
2

3
import StdMisc, StdArray, StdList, StdOrdList, StdTuple, StdChar, StdFile, StdBool, StdEnum
4 5
import iTasks.WF.Combinators.Common
import iTasks.WF.Tasks.System
6 7

import StdInt, StdChar, StdString
8
from StdFunc import o, seqList, ::St, const, id
9 10 11 12

import tcp
import Internet.HTTP, System.GetOpt, Data.Func, Data.Functor

13
from Data.Map import :: Map
14
from Data.Queue import :: Queue(..)
15 16
from Data.Set import :: Set, newSet

17
import qualified Data.Map as DM
Haye Böhm's avatar
Haye Böhm committed
18
from System.OS import IF_POSIX_OR_WINDOWS, OS_NEWLINE, IF_WINDOWS
19

20
import Data.List, Data.Error, Data.Func, Data.Tuple, Math.Random, Text
21
import System.Time, System.CommandLine, System.Environment, System.OSError, System.File, System.FilePath, System.Directory
22

23 24 25
import iTasks.Internal.Util, iTasks.Internal.HtmlUtil
import iTasks.Internal.IWorld, iTasks.Internal.WebService, iTasks.Internal.SDSService
import qualified iTasks.Internal.SDS as SDS
26
import iTasks.UI.Layout, iTasks.UI.Layout.Default
27

28
from iTasks.WF.Tasks.SDS import get
29
from iTasks.WF.Combinators.Tune import class tune(..), instance tune ApplyLayout Task, :: ApplyLayout(..)
30
from iTasks.SDS.Combinators.Common import sdsFocus
31
from iTasks.SDS.Sources.System import applicationOptions
32

33
import iTasks.Internal.IWorld, iTasks.Internal.TaskEval, iTasks.Internal.TaskStore
34 35
import iTasks.Internal.Util
import iTasks.Internal.TaskServer
36
import iTasks.Internal.EngineTasks
37
import iTasks.Internal.Distributed.Symbols
38

39 40
from Sapl.Linker.LazyLinker import generateLoaderState, :: LoaderStateExt
from Sapl.Linker.SaplLinkerShared import :: SkipSet
41
from Sapl.Target.Flavour import :: Flavour, toFlavour
42

Mart Lubbers's avatar
Mart Lubbers committed
43 44
MAX_EVENTS 		        :== 5

45
derive class iTask EngineOptions
46

47 48
doTasks :: a !*World -> *World | Startable a
doTasks startable world = doTasksWithOptions defaultEngineCLIOptions startable world
49

50
doTasksWithOptions :: ([String] EngineOptions -> MaybeError [String] EngineOptions) a !*World -> *World | Startable a
51
doTasksWithOptions initFun startable world
52 53
	# (cli,world)			= getCommandLine world
	# (options,world)       = defaultEngineOptions world
54 55 56
	# mbOptions             = initFun cli options
	| mbOptions =:(Error _) = show (fromError mbOptions) world
	# options               = fromOk mbOptions
57 58 59
	# iworld				= createIWorld options world
	# (res,iworld) 			= initJSCompilerState iworld
	| res =:(Error _) 		= show ["Fatal error: " +++ fromError res] (destroyIWorld iworld)
Haye Böhm's avatar
Haye Böhm committed
60 61
	# (symbolsResult, iworld) = initSymbolsShare options.distributed options.appName iworld
	| symbolsResult =: (Error _) = show ["Error reading symbols while required: " +++ fromError symbolsResult] (destroyIWorld iworld)
62
	# iworld				= serve (startupTasks options) (tcpTasks options.serverPort options.keepaliveTime)
63 64
	                                engineTasks (timeout options.timeout) iworld
	= destroyIWorld iworld
65
where
66
    webTasks = [t \\ WebTask t <- toStartable startable]
67
	startupTasks {distributed, sdsPort} = (if distributed [case onStartup (sdsServiceTask sdsPort) of StartupTask t = t;] []) ++ [t \\ StartupTask t <- toStartable startable]
68 69
	hasWebTasks = not (webTasks =: [])

Haye Böhm's avatar
Haye Böhm committed
70
	initSymbolsShare False _ iworld = (Ok (), iworld)
Haye Böhm's avatar
Haye Böhm committed
71
	initSymbolsShare True appName iworld = case storeSymbols (IF_WINDOWS (appName +++ ".exe") appName) iworld of
Haye Böhm's avatar
Haye Böhm committed
72
		(Error (e, s), iworld) = (Error s, iworld)
73
		(Ok noSymbols, iworld) = (Ok (),  {iworld & world = show ["Read number of symbols: " +++ toString noSymbols] iworld.world})
Haye Böhm's avatar
Haye Böhm committed
74

75 76 77 78 79
	//Only run a webserver if there are tasks that are started through the web
	tcpTasks serverPort keepaliveTime
		| webTasks =: [] = []
		| otherwise
			= [(serverPort,httpServer serverPort keepaliveTime (engineWebService webTasks) taskOutput)]
80

Mart Lubbers's avatar
Mart Lubbers committed
81
	engineTasks =
82 83
 		[BackgroundTask updateClock,
 		 BackgroundTask (processEvents MAX_EVENTS)
84
		:if (webTasks =: [])
85
			[BackgroundTask stopOnStable]
86 87
			[BackgroundTask removeOutdatedSessions
		 	,BackgroundTask flushWritesWhenIdle
88 89
			]
		]
90

91
	// The iTasks engine consist of a set of HTTP Web services
92
	engineWebService :: [WebTask] -> [WebService (Map InstanceNo TaskOutput) (Map InstanceNo TaskOutput)]
93 94 95 96 97 98 99 100 101 102 103 104 105
	engineWebService webtasks =
		[taskUIService webtasks
		,documentService
		,staticResourceService [path \\ {WebTask|path} <- webtasks]
		]

	show :: ![String] !*World -> *World
	show lines world
		# (console,world)	= stdio world
		# console			= seqSt (\s c -> fwrites (s +++ OS_NEWLINE) c) lines console
		# (_,world)			= fclose console world
		= world

106
defaultEngineCLIOptions :: [String] EngineOptions -> MaybeError [String] EngineOptions
107 108 109 110 111 112 113 114 115 116 117 118 119
defaultEngineCLIOptions [argv0:argv] defaults
	# (settings, positionals, errs) = getOpt Permute opts argv
	| not (errs =: []) = Error errs
	| not (positionals =: []) = Error ["Positional arguments not allowed"]
	= case foldl (o) id settings (Just defaults) of
		Nothing = (Error [usageInfo ("Usage " +++ argv0 +++ "[OPTIONS]") opts])
		Just settings = Ok settings
where
	opts :: [OptDescr ((Maybe EngineOptions) -> Maybe EngineOptions)]
	opts =
		[ Option ['?'] ["help"] (NoArg $ const Nothing)
			"Display this message"
		, Option ['p'] ["port"] (ReqArg (\p->fmap \o->{o & serverPort=toInt p}) "PORT")
120
			("Specify the HTTP port (default: " +++ toString defaults.serverPort +++ ")")
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
		, Option [] ["timeout"] (OptArg (\mp->fmap \o->{o & timeout=fmap toInt mp}) "MILLISECONDS")
			"Specify the timeout in ms (default: 500)\nIf not given, use an indefinite timeout."
		, Option [] ["keepalive"] (ReqArg (\p->fmap \o->{o & keepaliveTime={tv_sec=toInt p,tv_nsec=0}}) "SECONDS")
			"Specify the keepalive time in seconds (default: 300)"
		, Option [] ["sessiontime"] (ReqArg (\p->fmap \o->{o & sessionTime={tv_sec=toInt p,tv_nsec=0}}) "SECONDS")
			"Specify the expiry time for a session in seconds (default: 60)"
		, Option [] ["autolayout"] (NoArg (fmap \o->{o & autoLayout=True}))
			"Enable autolayouting (default)"
		, Option [] ["no-autolayout"] (NoArg (fmap \o->{o & autoLayout=False}))
			"Disable autolayouting"
		, Option [] ["persist-tasks"] (NoArg (fmap \o->{o & persistTasks=True}))
			"Enable the persistence of tasks"
		, Option [] ["no-persist-tasks"] (NoArg (fmap \o->{o & persistTasks=False}))
			"Disable the persistence of tasks (default)"
		, Option [] ["webdir"] (ReqArg (\p->fmap \o->{o & webDirPath=p}) "PATH")
			("Specify the folder containing static web content\ndefault: " +++ defaults.webDirPath)
		, Option [] ["storedir"] (ReqArg (\p->fmap \o->{o & storeDirPath=p}) "PATH")
			("Specify the folder containing the data stores\ndefault: " +++ defaults.storeDirPath)
		, Option [] ["tempdir"] (ReqArg (\p->fmap \o->{o & tempDirPath=p}) "PATH")
			("Specify the folder containing the temporary files\ndefault: " +++ defaults.tempDirPath)
		, Option [] ["sapldir"] (ReqArg (\p->fmap \o->{o & saplDirPath=p}) "PATH")
			("Specify the folder containing the sapl files\ndefault: " +++ defaults.saplDirPath)
143 144
		, Option [] ["distributed"] (NoArg (fmap \o->{o & distributed=True}))
			"Enable distributed mode (populate the symbols share)"
145 146
		, Option ['s'] ["sdsPort"] (ReqArg (\p->fmap \o->{o & sdsPort=toInt p}) "SDSPORT")
			("Specify the SDS port (default: " +++ toString defaults.sdsPort +++ ")")
147
		]
148

149 150
onStartup :: (Task a) -> StartableTask | iTask a
onStartup task = StartupTask {StartupTask|attributes = defaultValue, task = TaskWrapper task}
151

152 153 154 155 156 157 158 159
onRequest :: String (Task a) -> StartableTask | iTask a
onRequest path task = WebTask {WebTask|path = path, task = WebTaskWrapper (const task)}

onStartupWithAttributes :: (Task a) TaskAttributes -> StartableTask | iTask a
onStartupWithAttributes task attributes = StartupTask {StartupTask|attributes = attributes, task = TaskWrapper task}

onRequestFromRequest :: String (HTTPRequest -> Task a) -> StartableTask | iTask a
onRequestFromRequest path task = WebTask {WebTask|path = path, task = WebTaskWrapper task}
160 161

class Startable a
Bas Lijnse's avatar
Bas Lijnse committed
162
where
163 164 165
	toStartable :: !a -> [StartableTask]

instance Startable (Task a) | iTask a //Default as web task
166
where
167
	toStartable task =
168 169
		[onStartup viewWebServerInstructions
		,onRequest "/" task
170
		]
171

172
instance Startable (HTTPRequest -> Task a) | iTask a //As web task
173
where
174
	toStartable task =
175 176
		[onStartup viewWebServerInstructions
		,onRequestFromRequest "/" task
177
		]
178

179
instance Startable StartableTask
180
where
181
	toStartable task = [task]
182

183
instance Startable [StartableTask]
184
where
185
	toStartable list = list
186

187 188 189 190
instance Startable (a,b) | Startable a & Startable b
where
	toStartable (x,y) = toStartable x ++ toStartable y

191 192 193 194 195 196 197 198 199 200 201 202
viewWebServerInstructions :: Task String
viewWebServerInstructions
	=   get applicationOptions
	>>- \{EngineOptions|appName,serverPort} ->
			traceValue (join OS_NEWLINE
				["*** " +++ appName +++ " HTTP server ***"
				,""
				,"Running at http://localhost" +++
					if (serverPort == 80)
						"/"
						(":" +++ toString serverPort +++ "/")
				])
203

204 205
defaultEngineOptions :: !*World -> (!EngineOptions,!*World)
defaultEngineOptions world
206
	# (appPath,world)    = determineAppPath world
207 208 209
	# (appVersion,world) = determineAppVersion appPath world
	# appDir             = takeDirectory appPath
	# appName            = (dropExtension o dropDirectory) appPath
210
	# options =
211
		{ appName			= appName
212
		, appPath			= appPath
213
		, appVersion        = appVersion
214 215
		, serverPort		= IF_POSIX_OR_WINDOWS 8080 80
        , serverUrl         = "http://localhost/"
216 217
		, keepaliveTime     = {tv_sec=300,tv_nsec=0} // 5 minutes
		, sessionTime       = {tv_sec=60,tv_nsec=0}  // 1 minute, (the client pings every 10 seconds by default)
Bas Lijnse's avatar
Bas Lijnse committed
218
        , persistTasks      = False
219
		, autoLayout        = True
220
		, distributed       = False
221
		, sdsPort			= 9090
222
		, timeout			= Just 500
223 224 225 226 227 228 229
		, webDirPath 		= appDir </> appName +++ "-www"
		, storeDirPath      = appDir </> appName +++ "-data" </> "stores"
		, tempDirPath       = appDir </> appName +++ "-data" </> "tmp"
		, saplDirPath 	    = appDir </> appName +++ "-sapl"
		}
	= (options,world)

ecrombag's avatar
ecrombag committed
230
// Determines the server executables path
231
determineAppPath :: !*World -> (!FilePath, !*World)
ecrombag's avatar
ecrombag committed
232
determineAppPath world
233
	# ([arg:_],world) = getCommandLine world
234
	| dropDirectory arg <> "ConsoleClient.exe"	= toCanonicalPath arg world
235 236 237
	//Using dynamic linker:
	# (res, world)				= getCurrentDirectory world
	| isError res				= abort "Cannot get current directory."
238
	# currentDirectory			= fromOk res
239 240
	# (res, world)				= readDirectory currentDirectory world
	| isError res				= abort "Cannot read current directory."
241
	# batchfiles				= [f \\ f <- fromOk res | takeExtension f == "bat" ]
242 243 244 245 246
	| isEmpty batchfiles		= abort "No dynamic linker batch file found."
	# (infos, world)			= seqList (map getFileInfo batchfiles) world
	| any isError infos	 		= abort "Cannot get file information."
	= (currentDirectory </> (fst o hd o sortBy cmpFileTime) (zip2 batchfiles infos), world)
	where
247
		cmpFileTime (_,Ok {FileInfo | lastModifiedTime = x})
248
					(_,Ok {FileInfo | lastModifiedTime = y}) = timeGm x > timeGm y
249

250
//By default, we use the modification time of the application executable as version id
251
determineAppVersion :: !FilePath!*World -> (!String,!*World)
252 253
determineAppVersion appPath world
	# (res,world)       = getFileInfo appPath world
254
	| res =: (Error _)  = ("unknown",world)
255 256 257 258
	# tm				= (fromOk res).lastModifiedTime
	# version           = strfTime "%Y%m%d-%H%M%S" tm
	= (version,world)