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

3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
import Data.Func
import Data.Functor
import Data.Queue
import Internet.HTTP
import StdEnv
import System.CommandLine
import System.Directory
import System.File
import System.FilePath
import System.GetOpt
import System.OS
import Text
import iTasks.Internal.Distributed.Symbols
import iTasks.Internal.EngineTasks
import iTasks.Internal.IWorld
import iTasks.Internal.SDS
import iTasks.Internal.SDSService
import iTasks.Internal.TaskServer
import iTasks.Internal.TaskStore
import iTasks.Internal.Util
import iTasks.SDS.Sources.System
24
import iTasks.WF.Combinators.Common
25 26
import iTasks.WF.Definition
import iTasks.WF.Tasks.SDS
27
import iTasks.WF.Tasks.System
28

29
import qualified Data.Map as DM
30

31 32
from TCPIP import :: Timeout
from StdFunc import :: St, seqList
33

Mart Lubbers's avatar
Mart Lubbers committed
34 35
MAX_EVENTS 		        :== 5

36
derive class iTask EngineOptions
37

38 39
doTasks :: a !*World -> *World | Startable a
doTasks startable world = doTasksWithOptions defaultEngineCLIOptions startable world
40

41
doTasksWithOptions :: ([String] EngineOptions -> MaybeError [String] EngineOptions) a !*World -> *World | Startable a
42
doTasksWithOptions initFun startable world
43 44 45 46 47 48 49
	# (cli,world)                = getCommandLine world
	# (options,world)            = defaultEngineOptions world
	# mbOptions                  = initFun cli options
	| mbOptions =:(Error _)      = show (fromError mbOptions) world
	# options                    = fromOk mbOptions
	# iworld                     = createIWorld options world
	# (symbolsResult, iworld)    = initSymbolsShare options.distributed options.appName iworld
Haye Böhm's avatar
Haye Böhm committed
50
	| symbolsResult =: (Error _) = show ["Error reading symbols while required: " +++ fromError symbolsResult] (destroyIWorld iworld)
Mart Lubbers's avatar
Mart Lubbers committed
51
	# iworld                     = serve (startupTasks options) (tcpTasks options.serverPort options.keepaliveTime) (timeout options.timeout) iworld
52
	= destroyIWorld iworld
53
where
54
    webTasks = [t \\ WebTask t <- toStartable startable]
55
	startupTasks {distributed, sdsPort}
Mart Lubbers's avatar
cleanup  
Mart Lubbers committed
56
		//If distributed, start sds service task
57
		=  (if distributed [startTask (sdsServiceTask sdsPort)] [])
58 59 60
		++ [startTask flushWritesWhenIdle
		//If there no webtasks, stop when stable, otherwise cleanup old sessions
		   ,startTask if (webTasks =: []) stopOnStable removeOutdatedSessions
Mart Lubbers's avatar
cleanup  
Mart Lubbers committed
61
		//Start all startup tasks
62
		   :[t \\ StartupTask t <- toStartable startable]]
Mart Lubbers's avatar
cleanup  
Mart Lubbers committed
63

64
	startTask t = {StartupTask|attributes=defaultValue,task=TaskWrapper t}
Mart Lubbers's avatar
cleanup  
Mart Lubbers committed
65

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

71 72 73 74 75
	//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)]
76

77
	// The iTasks engine consist of a set of HTTP Web services
78
	engineWebService :: [WebTask] -> [WebService (Map InstanceNo TaskOutput) (Map InstanceNo TaskOutput)]
79 80 81 82 83 84 85 86 87 88 89 90 91
	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

92
defaultEngineCLIOptions :: [String] EngineOptions -> MaybeError [String] EngineOptions
93 94 95 96 97 98 99 100 101 102
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 =
103
		[ Option ['?'] ["help"] (NoArg (\_->Nothing))
104 105
			"Display this message"
		, Option ['p'] ["port"] (ReqArg (\p->fmap \o->{o & serverPort=toInt p}) "PORT")
106
			("Specify the HTTP port (default: " +++ toString defaults.serverPort +++ ")")
107 108 109 110
		, 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)"
111 112
		, Option [] ["maxevents"] (ReqArg (\p->fmap \o->{o & maxEvents=toInt p}) "NUM")
			"Specify the maximum number of events to process per loop (default: 5)"
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
		, 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)
131 132
		, Option [] ["distributed"] (NoArg (fmap \o->{o & distributed=True}))
			"Enable distributed mode (populate the symbols share)"
133 134
		, Option ['s'] ["sdsPort"] (ReqArg (\p->fmap \o->{o & sdsPort=toInt p}) "SDSPORT")
			("Specify the SDS port (default: " +++ toString defaults.sdsPort +++ ")")
135
		]
136

137 138
onStartup :: (Task a) -> StartableTask | iTask a
onStartup task = StartupTask {StartupTask|attributes = defaultValue, task = TaskWrapper task}
139

140 141 142 143 144 145 146 147
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}
148 149

class Startable a
Bas Lijnse's avatar
Bas Lijnse committed
150
where
151 152 153
	toStartable :: !a -> [StartableTask]

instance Startable (Task a) | iTask a //Default as web task
154
where
155
	toStartable task =
156 157
		[onStartup viewWebServerInstructions
		,onRequest "/" task
158
		]
159

160
instance Startable (HTTPRequest -> Task a) | iTask a //As web task
161
where
162
	toStartable task =
163 164
		[onStartup viewWebServerInstructions
		,onRequestFromRequest "/" task
165
		]
166

167
instance Startable StartableTask
168
where
169
	toStartable task = [task]
170

171
instance Startable [StartableTask]
172
where
173
	toStartable list = list
174

175 176 177 178
instance Startable (a,b) | Startable a & Startable b
where
	toStartable (x,y) = toStartable x ++ toStartable y

179 180 181 182 183 184 185 186 187 188 189 190
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 +++ "/")
				])
191

192 193
defaultEngineOptions :: !*World -> (!EngineOptions,!*World)
defaultEngineOptions world
194
	# (appPath,world)    = determineAppPath world
195 196 197
	# (appVersion,world) = determineAppVersion appPath world
	# appDir             = takeDirectory appPath
	# appName            = (dropExtension o dropDirectory) appPath
198
	# options =
199 200 201 202 203 204 205 206 207 208 209 210
		{ appName        = appName
		, appPath        = appPath
		, appVersion     = appVersion
		, serverPort     = IF_POSIX_OR_WINDOWS 8080 80
		, serverUrl      = "http://localhost/"
		, 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)
		, persistTasks   = False
		, autoLayout     = True
		, distributed    = False
		, maxEvents      = 5
		, sdsPort        = 9090
Mart Lubbers's avatar
Mart Lubbers committed
211
		, timeout        = Nothing//Just 500
212 213 214 215
		, webDirPath     = appDir </> appName +++ "-www"
		, storeDirPath   = appDir </> appName +++ "-data" </> "stores"
		, tempDirPath    = appDir </> appName +++ "-data" </> "tmp"
		, saplDirPath    = appDir </> appName +++ "-sapl"
216 217 218
		}
	= (options,world)

ecrombag's avatar
ecrombag committed
219
// Determines the server executables path
220
determineAppPath :: !*World -> (!FilePath, !*World)
ecrombag's avatar
ecrombag committed
221
determineAppPath world
222
	# ([arg:_],world) = getCommandLine world
223
	| dropDirectory arg <> "ConsoleClient.exe"	= toCanonicalPath arg world
224 225 226
	//Using dynamic linker:
	# (res, world)				= getCurrentDirectory world
	| isError res				= abort "Cannot get current directory."
227
	# currentDirectory			= fromOk res
228 229
	# (res, world)				= readDirectory currentDirectory world
	| isError res				= abort "Cannot read current directory."
230
	# batchfiles				= [f \\ f <- fromOk res | takeExtension f == "bat" ]
231 232 233 234 235
	| 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
236
		cmpFileTime (_,Ok {FileInfo | lastModifiedTime = x})
237
					(_,Ok {FileInfo | lastModifiedTime = y}) = timeGm x > timeGm y
238

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

timeout :: !(Maybe Timeout) !*IWorld -> (!Maybe Timeout,!*IWorld)
timeout mt iworld = case read taskEvents EmptyContext iworld of
	//No events
	(Ok (ReadingDone (Queue [] [])),iworld=:{sdsNotifyRequests,world})
		# (ts, world) = nsTime world
		= ( minListBy lesser [mt:flatten (map (getTimeoutFromClock ts) ('DM'.elems sdsNotifyRequests))]
		  , {iworld & world = world})
	(Ok (ReadingDone (Queue _ _)), iworld)               = (Just 0,iworld)   //There are still events, don't wait
	(Error _,iworld)            = (Just 500,iworld) //Keep retrying, but not too fast
where
	lesser (Just x) (Just y) = x < y
259 260
	lesser (Just _) Nothing  = True
	lesser _        _        = False
261 262 263 264 265 266 267 268 269 270 271 272 273

	getTimeoutFromClock :: Timespec (Map SDSNotifyRequest Timespec) -> [Maybe Timeout]
	getTimeoutFromClock now requests = map getTimeoutFromClock` ('DM'.toList requests)
	where
		getTimeoutFromClock` :: (!SDSNotifyRequest, !Timespec) -> Maybe Timeout
		getTimeoutFromClock` (snr=:{cmpParam=(ts :: ClockParameter Timespec)}, reqTimespec)
			| startsWith "$IWorld:timespec$" snr.reqSDSId && ts.interval <> zero
				# fire = iworldTimespecNextFire now reqTimespec ts
				= Just (max 0 (toMs fire - toMs now))
			= mt
		getTimeoutFromClock` _ = mt

	toMs x = x.tv_sec * 1000 + x.tv_nsec / 1000000