iTasksBasicCombinators.icl 14.9 KB
Newer Older
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
1 2 3 4 5 6 7 8 9 10 11 12
implementation module iTasksBasicCombinators

// *********************************************************************************************************************************
// This module contains the basic iTasks combinators
// *********************************************************************************************************************************
// iTask & iData Concept and Implementation: (c) 2006,2007,2008 - Rinus Plasmeijer
// *********************************************************************************************************************************
//
import StdList, StdArray, StdTuple, StdFunc
import dynamic_string, graph_to_string_with_descriptors, graph_to_sapl_string
import DrupBasic
import iDataTrivial, iDataFormlib
13 14
import iTasksTypes, iTasksLiftingCombinators
import InternaliTasksThreadHandling
15
import GenBimap
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
16

17 18 19
derive gForm 	[], Time
derive gUpd 	[], Time
derive gPrint	Time
20
derive gParse	Time
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
21

22

Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
// ******************************************************************************************************
// monads for combining iTasks

(=>>) infixl 1 :: !(Task a) !(a -> Task b) -> Task b | iCreateAndPrint b
(=>>) taska taskb = mybind
where
	mybind tst=:{options}
	# (a,tst=:{activated}) = taska tst
	| activated	= taskb a {tst & options = options}
	= (createDefault,tst)

return_V :: !a -> (Task a) | iCreateAndPrint a
return_V a  = mkTask "return_V" dotask
where
	dotask tst = (a,tst) 

	
// ******************************************************************************************************
// newTask needed for recursive task creation

newTask :: !String !(Task a) -> (Task a) 	| iData a 
newTask taskname mytask = mkTask taskname newTask`
where
	newTask` tst=:{tasknr,userId,options}		
	# taskId					= iTaskId userId tasknr taskname
48
	# (taskval,tst) 			= liftHst (mkStoreForm (Init,storageFormId options taskId (False,createDefault)) id) tst  // remember if the task has been done
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
49 50 51 52 53
	# (taskdone,taskvalue)		= taskval.value										// select values
	| taskdone					= (taskvalue,tst)									// if rewritten return stored value
	# (val,tst=:{activated})	= mytask {tst & tasknr = [-1:tasknr]} 				// do task, first shift tasknr
	| not activated				= (createDefault,{tst & tasknr = tasknr, options = options})	// subtask not ready, return value of subtasks
	# tst						= deleteSubTasksAndThreads tasknr tst				// task ready, garbage collect it
54
	# (_,tst) 					= liftHst (mkStoreForm (Init,storageFormId options taskId (False,createDefault)) (\_ -> (True,val))) tst  // remember if the task has been done
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
	= (val,{tst & tasknr = tasknr, options = options})


Once :: !String !(Task a) -> (Task a) | iData a
Once label task = mkTask label doit
where
	doit tst=:{activated,html,tasknr,hst,userId,options}
	# taskId			= iTaskId userId tasknr (label +++ "_")
	# (store,hst) 		= mkStoreForm (Init,storageFormId options taskId (False,createDefault)) id hst  			
	# (done,value)		= store.value
	| done 				= (value,{tst & hst = hst})													// if task has completed, don't do it again
	# (value,tst=:{hst})= task {tst & hst = hst}
	# (store,hst) 		= mkStoreForm (Init,storageFormId options taskId (False,createDefault)) (\_ -> (True,value)) hst 	// remember task status for next time
	# (done,value)		= store.value
	= (value,{tst & activated = done, hst = hst})													// task is now completed, handle as previously

// ******************************************************************************************************
// looping tasks

// when gc option set and task finished, it will throw away all subtasks and start all over
// otherwise, when task finshed it will remember the new tasknr to prevent checking of previously finished tasks

foreverTask :: !(Task a) -> Task a | iData a
foreverTask task = mkTask "foreverTask" foreverTask`
where
	foreverTask` tst=:{tasknr,activated,userId,options,html} 
	| options.gc == Collect																				// garbace collect everything when task finsihed
		# (val,tst=:{activated})= task {tst & tasknr = [-1:tasknr]}										// shift tasknr
		| activated 			= foreverTask` (deleteSubTasksAndThreads tasknr {tst & tasknr = tasknr, options = options, html = html}) 			// loop
		= (val,tst)					
	# taskId					= iTaskId userId tasknr "ForSt"											// create store id
86
	# (currtasknr,tst)			= liftHst (mkStoreForm (Init,storageFormId options taskId tasknr) id) tst		// fetch actual tasknr
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
87 88 89
	# (val,tst=:{activated})	= task {tst & tasknr = [-1:currtasknr.value]}
	| activated 																						// task is completed	
		# ntasknr				= incNr currtasknr.value												// incr tasknr
90
		# (currtasknr,tst)		= liftHst (mkStoreForm (Init,storageFormId options taskId tasknr) (\_ -> ntasknr)) tst // store next task nr
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
91 92 93 94 95 96 97 98 99 100
		= foreverTask` {tst & tasknr = tasknr, options = options, html = html}										// initialize new task
	= (val,tst)					

(<!) infixl 6 :: !(Task a) !(a -> .Bool) -> Task a | iCreateAndPrint a
(<!) taska pred = mkTask "less!" doTask
where
	doTask tst=:{activated, tasknr}
	# (a,tst=:{activated}) 	= taska {tst & tasknr = [-1:tasknr]}
	| not activated 		= (a,tst)
	| not (pred a)			
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
101 102 103
		# tst = deleteSubTasksAndThreads [0:tasknr] tst
		= doTask {tst & tasknr = tasknr}
//		= (a,{tst & activated = False})
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
104 105 106 107 108
	= (a,tst)

// ******************************************************************************************************
// Assigning tasks to users, each user has to be identified by an unique number >= 0

109 110
assignTaskTo :: !UserId !(LabeledTask a) -> Task a | iData a	
assignTaskTo nuserId (taskname,taska) = assignTaskTo`
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
111
where
112
	assignTaskTo` tst=:{html=ohtml,tasknr,activated,userId,workflowLink=(_,(_,processNr,workflowLabel))}
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
113
	| not activated						= (createDefault,tst)
114
	# (currtime,tst)					= appWorldOnce "time" time tst
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
115
	# tst								= IF_Ajax (administrateNewThread userId tst) tst 
116
	# (a,tst=:{html=nhtml,activated})	= IF_Ajax (UseAjax @>> taska) taska {tst & html = BT [] [],userId = nuserId}		// activate task of indicated user
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
117 118 119 120
	| activated 						= (a,{tst & activated = True						// work is done	
												  ,	userId = userId							// restore previous user id						
												  ,	html = ohtml })							// plus new one tagged
	= (a,{tst & userId = userId																// restore user Id
121 122
			  , html = 	ohtml +|+ (	{ delegatorId 	= userId
									, taskWorkerId	= nuserId
123
									, taskNrId		= showTaskNr tasknr
124 125
									, processNr		= processNr
									, worflowLabel	= workflowLabel
126
									, taskPriority	= NormalPriority
127
									, taskLabel		= taskname
128
									, timeCreated	= currtime
129
							 		} @@: nhtml)
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
130 131 132 133 134 135
		 })												

// ******************************************************************************************************
// sequencingtasks

seqTasks :: ![LabeledTask a] -> (Task [a])| iCreateAndPrint a
136
seqTasks [(label,task)] = task =>> \na -> return_V [na]
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
137 138 139 140 141 142 143 144 145
seqTasks options = mkTask "seqTasks" seqTasks`
where
	seqTasks` tst=:{tasknr}
	# (val,tst)	 = doseqTasks options [] {tst & tasknr = [-1:tasknr]}
	= (val,{tst & tasknr = tasknr})

	doseqTasks [] accu tst 		= (reverse accu,{tst & activated = True})
	doseqTasks [(taskname,task):ts] accu tst=:{html,options} 
	# (a,tst=:{activated=adone,html=ahtml}) 
146 147
									= task {tst & activated = True, html = BT [] []}
	| not adone						= (reverse accu,{tst & html = html +|+ BT [showLabel taskname,BrTag [] ,BrTag []] [] +|+ ahtml})
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
148 149 150
	= doseqTasks ts [a:accu] {tst & html = html +|+ ahtml, options = options}

// ******************************************************************************************************
151
// Select the tasks to do from a list with help of another task for selecting them:
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
152

153
selectTasks 	:: !(SelectingTask a) !(OrderingTask a) ![LabeledTask a] -> Task [a] | iData a
154
selectTasks chooser executer ltasks = newTask "selectTask" selectTasks`
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
155
where
156
	selectTasks`
157 158 159 160
	=						chooser ltasks
			=>> \chosen -> 	executer [ltasks!!i \\ i <- chosen | i >=0 && i < lengthltask]
			
	lengthltask = length ltasks
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
161 162


163 164 165 166 167 168 169 170 171 172

allTasksCond 	:: !String !(TasksToShow a) !(FinishPred a) ![LabeledTask a] -> Task [a] | iData a 
allTasksCond label chooser pred taskCollection 
= 					mkTask "andTasksCond" (doandTasks chooser taskCollection)
where
	lengthltask = length taskCollection 

	doandTasks chooser [] tst	= return [] tst
	doandTasks chooser taskCollection tst=:{tasknr,html,options,userId}
	# ((alist,acode),tst=:{activated=finished,html=allhtml})		
173
						= checkAllTasks label taskCollection 0 True ([],[]) {tst & html = BT [] [],activated = True} 
174 175 176
	| finished			= (alist,{tst & html = html}) 						// stop, all andTasks are finished
	| pred alist		= (alist,{tst & html = html, activated = True}) 	// stop, all work done so far satisfies predicate
	# selectId			= iTaskId userId tasknr "anTaskSelect"
177 178
	# ((selected,shtml),tst)	= chooser selectId taskCollection {tst & html = BT [] []}
	# (_,tst=:{html=ashtml})	= showtasks label [(i,taskCollection!!i) \\ i <- selected | i >= 0 && i < lengthltask] {tst & html = BT [] [], activated = True}		
179 180
	= (alist,{tst 	& activated = finished
					, html = 	html +|+ 									// show previous code
181 182
								((BT shtml []) +-+ ashtml) +|+ 				// show selection button + selected itasks
								(userId -@: foldl (+|+) (BT [] []) [htmlcode \\ htmlcode <- acode & i <- [0..] | not (isMember i selected)]) // dont show non selected itasks, but scan them for task tree info								
183 184 185 186 187
			})
	where
		showtasks :: !String ![(!Int,!LabeledTask a)] !*TSt -> *(![a],!*TSt) | iCreateAndPrint a
		showtasks _ [] tst			= ([],tst)
		showtasks label [(chosen,(name,chosenTask)):tasks] tst=:{html=html}
188 189
		# (a,tst=:{html=ahtml}) 	= mkParSubTask label chosen chosenTask {tst & tasknr = tasknr, activated = True, html = BT [] []}
		# (as,tst=:{html=ashtml})	= showtasks label tasks {tst & html = BT [] []}
190 191 192 193 194 195 196 197
		= ([a:as],{tst & html = html +|+ ahtml +|+ ashtml})			


		checkAllTasks :: !String ![LabeledTask a] !Int !Bool !(![a],![HtmlTree]) !*TSt -> *(!(![a],![HtmlTree]),!*TSt) | iCreateAndPrint a
		checkAllTasks traceid taskCollection ctasknr bool (alist,acode) tst=:{tasknr}
		| ctasknr == length taskCollection 	= ((reverse alist,reverse acode),{tst & activated = bool})			// all tasks tested
		# (taskname,task)		= taskCollection!!ctasknr
		# (a,tst=:{activated = adone,html=html})	
198
								= mkParSubTask traceid ctasknr task {tst & tasknr = tasknr, activated = True, html = BT [] []} // check tasks
199 200
		| adone					= checkAllTasks traceid taskCollection (inc ctasknr) bool ([a:alist],[html:acode]) {tst & tasknr = tasknr, activated = True}
		= checkAllTasks traceid taskCollection (inc ctasknr) False (alist,[html:acode]) {tst & tasknr = tasknr, activated = True}
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223

// ******************************************************************************************************
// Higher order tasks ! Experimental
/* Experimental department:

   May not work when the tasks are garbage collected !!

-!>				:: a task, either finished or interrupted (by completion of the first task) is returned in the closure
				   if interrupted, the work done so far is returned (!) which can be continued somewhere else
channel			:: splits a task in respectively a sender task closure and receiver taskclosure; 
				   when the sender is evaluated, the original task is evaluated as usual;
				   when the receiver task is evaluated, it will wait upon completeion of the sender and then get's its result;
				   Important: Notice that a receiver will never finish if you don't activate the corresponding receiver somewhere.
closureTask		:: The task is executed as usual, but a receiver closure is returned immediately.
				   When the closure is evaluated somewhere, one has to wait until the task is finished.
				   Handy for passing a result to several interested parties.
closureLZTask	:: Same, but now the original task will not be done unless someone is asking for the result somewhere.
*/

(-!>) infix 4  :: (Task s) (Task a) -> (Task (Maybe s,TCl a)) | iCreateAndPrint s & iCreateAndPrint a
(-!>)  stoptask task =  mkTask "-!>" stop`
where
	stop` tst=:{tasknr,html,options,userId}
224 225
	# (val,tst=:{activated = taskdone,html = taskhtml}) = task     {tst & activated = True, html = BT [] [], tasknr = normalTaskId,options = options}
	# (s,  tst=:{activated = stopped, html = stophtml})	= stoptask {tst & activated = True, html = BT [] [], tasknr = stopTaskId,  options = options}
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
	| stopped	= return_V (Just s, TCl (close task))   {tst & html = html, activated = True}
	| taskdone	= return_V (Nothing,TCl (return_V val)) {tst & html = html +|+ taskhtml, activated = True}
	= return_V (Nothing,TCl (return_V val)) {tst & html = html +|+ taskhtml +|+ stophtml, activated = False}
	where
		close t = \tst -> t {tst & tasknr = normalTaskId, options = options, userId = userId} // reset userId because it influences the task id

		stopTaskId 		= [-1,0:tasknr]
		normalTaskId  	= [-1,1:tasknr]

channel  :: String (Task a) -> (Task (TCl a,TCl a)) | iCreateAndPrint a
channel name task =  mkTask "channel" (doSplit name task)

doSplit name task tst=:{tasknr,options,userId}
= return_V (TCl (sender myTask),TCl (receiver myTask)) tst
where
	myTask tst = task {tst & tasknr = [-1:tasknr], options = options, userId = userId}

	sender task tst=:{activated,tasknr}
	| not activated				= (createDefault,tst)
	# (val,tst) 				= task tst
	= (val,{tst & tasknr = tasknr})

	receiver task  tst=:{activated,tasknr,html}
	| not activated			 	= (createDefault,tst)
	# (val,tst=:{activated}) 	= task tst
	| activated	= (val,{tst & html = html, activated = True , tasknr = tasknr})
	= (val,{tst & html = html /*+|+ BT [showText ("Waiting for completion of "<+++ name)]*/, tasknr = tasknr})

Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
254 255
closureTask  ::  (LabeledTask a) -> (Task (TCl a)) | iCreateAndPrint a
closureTask (name, task) = mkTask ("closure " +++ name) mkClosure
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
256 257 258 259 260 261
where
	mkClosure tst=:{tasknr,options,userId}
	# ((TCl sa,ra),tst) 	= doSplit name task tst
	# (_,tst)     			= sa {tst & activated = True}
	= (ra, {tst & activated = True})

Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
262 263
closureLzTask  :: (LabeledTask a) -> (Task (TCl a)) | iCreateAndPrint a
closureLzTask (name, task) = mkTask ("lazy closure " +++ name) mkClosure
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
where
	mkClosure tst=:{tasknr,options,userId}
	# ((TCl sa,ra),tst) 	= doSplit name task tst
	# (_,tst)     			= sa tst
	= (ra, {tst & activated = True})

	doSplit name task tst=:{tasknr,options,userId}
	= return_V (TCl (sender myTask),TCl (receiver myTask)) tst
	where
		myTask tst = task {tst & tasknr = [-1:tasknr], options = options, userId = userId}
	
		sender task tst=:{activated,tasknr}
		| not activated				= (createDefault,tst)
		# (requested,tst)			= (sharedMem id) tst  // is this task demanded ?
		| not requested.value		= (createDefault,tst)
		# (val,tst) 				= task tst
		= (val,{tst & tasknr = tasknr})
	
		receiver task  tst=:{activated,tasknr,html}
		| not activated			 	= (createDefault,tst)
		# (requested,tst)			= (sharedMem (\_ -> True)) tst  // this task is now demanded !
		# (val,tst=:{activated}) 	= task tst
		| activated	= (val,{tst & html = html, activated = True , tasknr = tasknr})
		= (val,{tst & html = html /*+|+ BT [showText ("Waiting for completion of "<+++ name)]*/, tasknr = tasknr})

		sharedStoreId	= iTaskId userId tasknr "Shared_Store"
290
		sharedMem fun	= liftHst (mkStoreForm (Init,storageFormId options sharedStoreId False) fun)
Rinus Plasmeijer's avatar
Rinus Plasmeijer committed
291 292 293