summaryrefslogtreecommitdiffstats
path: root/module/interaction/InteractionTask.py
diff options
context:
space:
mode:
Diffstat (limited to 'module/interaction/InteractionTask.py')
-rw-r--r--module/interaction/InteractionTask.py100
1 files changed, 0 insertions, 100 deletions
diff --git a/module/interaction/InteractionTask.py b/module/interaction/InteractionTask.py
deleted file mode 100644
index d2877b2b0..000000000
--- a/module/interaction/InteractionTask.py
+++ /dev/null
@@ -1,100 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 3 of the License,
- or (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- See the GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; if not, see <http://www.gnu.org/licenses/>.
-
- @author: RaNaN
-"""
-
-from time import time
-
-from module.Api import InteractionTask as BaseInteractionTask
-from module.Api import Interaction, InputType, Input
-
-#noinspection PyUnresolvedReferences
-class InteractionTask(BaseInteractionTask):
- """
- General Interaction Task extends ITask defined by api with additional fields and methods.
- """
- #: Plugins can put needed data here
- storage = None
- #: Timestamp when task expires
- wait_until = 0
- #: The received result
- result = None
- #: List of registered handles
- handler = None
- #: Error Message
- error = None
- #: Timeout locked
- locked = False
- #: A task that was retrieved counts as seen
- seen = False
- #: A task that is relevant to every user
- shared = False
- #: primary uid of the owner
- owner = None
-
- def __init__(self, *args, **kwargs):
- if 'owner' in kwargs:
- self.owner = kwargs['owner']
- del kwargs['owner']
- if 'shared' in kwargs:
- self.shared = kwargs['shared']
- del kwargs['shared']
-
- BaseInteractionTask.__init__(self, *args, **kwargs)
-
- # additional internal attributes
- self.storage = {}
- self.handler = []
- self.wait_until = 0
-
- def convertResult(self, value):
- #TODO: convert based on input/output
- return value
-
- def getResult(self):
- return self.result
-
- def setShared(self):
- """ enable shared mode, should not be reversed"""
- self.shared = True
-
- def setResult(self, value):
- self.result = self.convertResult(value)
-
- def setWaiting(self, sec, lock=False):
- """ sets waiting in seconds from now, < 0 can be used as infinitive """
- if not self.locked:
- if sec < 0:
- self.wait_until = -1
- else:
- self.wait_until = max(time() + sec, self.wait_until)
-
- if lock: self.locked = True
-
- def isWaiting(self):
- if self.result or self.error or self.timedOut():
- return False
-
- return True
-
- def timedOut(self):
- return time() > self.wait_until > -1
-
- def correct(self):
- [x.taskCorrect(self) for x in self.handler]
-
- def invalid(self):
- [x.taskInvalid(self) for x in self.handler] \ No newline at end of file