Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

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

48

49

50

51

52

53

54

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

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

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

254

255

256

257

258

259

260

261

262

263

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

290

291

292

293

294

295

296

297

298

299

#! /usr/bin/env python3 

# -*- coding: utf-8 -*- 

 

#       Copyright 2011-2012, Milan Boers 

#       Copyright 2011-2013, Marten de Vries 

#       Copyright 2011-2012, Cas Widdershoven 

# 

#       This file is part of OpenTeacher. 

# 

#       OpenTeacher 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. 

# 

#       OpenTeacher 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 OpenTeacher.  If not, see <http://www.gnu.org/licenses/>. 

 

import weakref 

 

#FIXME? Make the whole module make use of a .resources attribute like 

#topo. It would make media savers and loaders a lot easier to write (see 

#mediaHtml.py and the loader and saver otmd.py). Downside: breaks 

#compatibility. :( 

# 

#Maybe a solution: deprecate the filename key and replace it by 

#a 'resource' key. (and 'link' in the case of 'remote'), but give it a 

#content for backward compatibility. Doesn't fix the clutter in the otmd 

#savers, but the general problem would be solved by that I guess... 

 

class MediaLessonModule: 

        """The module""" 

 

        def __init__(self, mm,*args,**kwargs): 

                super().__init__(*args, **kwargs) 

 

                self._mm = mm 

 

                self.type = "lesson" 

                x = 667 

                self.priorities = { 

                        "all": x, 

                        "selfstudy": x, 

                        "student@home": x, 

                        "student@school": x, 

                        "teacher": x, 

                        "code-documentation": x, 

                        "test-suite": x, 

                        "default": -1, 

                } 

 

                self.dataType = "media" 

 

                self.uses = ( 

                        self._mm.mods(type="translator"), 

                        self._mm.mods(type="dataTypeIcons"), 

                ) 

                self.requires = ( 

                        self._mm.mods(type="event"), 

                        self._mm.mods(type="ui"), 

                        self._mm.mods(type="buttonRegister"), 

                        self._mm.mods(type="mediaEnterer"), 

                        self._mm.mods(type="mediaTeacher"), 

                        self._mm.mods(type="testsViewer"), 

                ) 

                self.filesWithTranslations = ("media.py",) 

 

        def enable(self): 

                global QtWidgets 

                try: 

                        from PyQt5 import QtWidgets 

                except ImportError: 

                        return 

                self._modules = set(self._mm.mods(type="modules")).pop() 

 

                self._lessons = set() 

 

                module = self._modules.default("active", type="buttonRegister") 

                self._button = module.registerButton("create") 

                self._button.clicked.handle(self.createLesson) 

                try: 

                        iconPath = self._modules.default("active", type="dataTypeIcons").findIcon(self.dataType) 

                except (IndexError, KeyError): 

                        pass 

                else: 

                        self._button.changeIcon.send(iconPath) 

                #reasonable priority 

                self._button.changePriority.send(self.priorities["all"]) 

 

                self.lessonCreated = self._modules.default(type="event").createEvent() 

                self.lessonCreationFinished = self._modules.default(type="event").createEvent() 

 

                #setup translation 

                global _ 

                global ngettext 

 

                #load translator 

                try: 

                        translator = self._modules.default("active", type="translator") 

                except IndexError: 

                        pass 

                else: 

                        translator.languageChanged.handle(self._retranslate) 

                self._retranslate() 

 

                self.active = True 

 

        def disable(self): 

                self.active = False 

 

                del self._modules 

                del self._lessons 

                del self._button 

                del self.lessonCreated 

                del self.lessonCreationFinished 

 

        def createLesson(self): 

                module = self._modules.default("active", type="ui") 

 

                self.enterWidget = self._modules.default("active", type="mediaEnterer").createMediaEnterer() 

                self.teachWidget = self._modules.default("active", type="mediaTeacher").createMediaTeacher() 

                self.resultsWidget = self._modules.default("active", type="testsViewer").createTestsViewer() 

 

                self.fileTab = module.addFileTab( 

                        self.enterWidget, 

                        self.teachWidget, 

                        self.resultsWidget 

                ) 

 

                lesson = Lesson(self._modules, self.fileTab, self.enterWidget, self.teachWidget, self.resultsWidget) 

                self._lessons.add(weakref.ref(lesson)) 

                self.lessonCreated.send(lesson) 

 

                #so it can set the changed property 

                self.enterWidget.lesson = lesson 

 

                self.lessonCreationFinished.send() 

                return lesson 

 

        def _retranslate(self): 

                #Translations 

                global _ 

                global ngettext 

 

                try: 

                        translator = self._modules.default("active", type="translator") 

                except IndexError: 

                        _, ngettext = str, lambda a, b, n: a if n == 1 else b 

                else: 

                        _, ngettext = translator.gettextFunctions( 

                                self._mm.resourcePath("translations") 

                        ) 

 

                self._button.changeText.send(_("Create media lesson")) 

160                for ref in self._lessons: 

                        lesson = ref() 

                        if lesson: 

                                lesson.retranslate() 

 

class Lesson: 

        """Lesson object (that means: this teachwidget+enterwidget)""" 

 

        def __init__(self, modules, fileTab, enterWidget, teachWidget, resultsWidget, *args, **kwargs): 

                super().__init__(*args, **kwargs) 

 

                self._modules = modules 

 

                self.enterWidget = enterWidget 

                self.teachWidget = teachWidget 

                self.resultsWidget = resultsWidget 

                self.fileTab = fileTab 

 

                #default 

                self._changed = False 

 

                self.stopped = self._modules.default(type="event").createEvent() 

 

                self.module = self 

                self.resources = {} 

                self.dataType = "media" 

 

                self.fileTab.closeRequested.handle(self.stop) 

                self.fileTab.tabChanged.handle(self.tabChanged) 

                self.teachWidget.lessonDone.connect(self.toEnterTab) 

                self.teachWidget.listChanged.connect(self.teachListChanged) 

 

                self.changedEvent = self._modules.default(type="event").createEvent() 

 

                self.retranslate() 

 

        def _updateTitle(self): 

                title = self.list.get("title", u"") 

                if not title: 

                        title = _("Unnamed") 

                self.fileTab.title = _("Media lesson: %s") % title 

 

        retranslate = _updateTitle 

 

        @property 

        def changed(self): 

                return self._changed 

 

        @changed.setter 

        def changed(self, value): 

                self._changed = value 

                self._updateTitle() 

                self.changedEvent.send() 

 

        @changed.deleter 

        def changed(self): 

                del self._changed 

 

        @property 

        def list(self): 

                return self.enterWidget.list 

 

        @list.setter 

        def list(self, list): 

                # Check if all the items are supported 

                modules = self._modules.sort("active", type="mediaType") 

                for item in list["items"]: 

                        itemSupported = False 

                        for module in modules: 

                                if module.supports(item["filename"]): 

                                        itemSupported = True 

                                        break 

                        if not itemSupported: 

                                QtWidgets.QMessageBox.critical(self.enterWidget, _("Unsupported media"), _("This type of media isn't supported on your computer")) 

                                self.stop() 

                                return 

                # Load the list 

                self.enterWidget.list = list 

                # Update the widgets 

                self.enterWidget.updateWidgets() 

                # Update the results widget 

                self.resultsWidget.updateList(list, "media") 

 

        def stop(self): 

                #close current lesson (if one). Just reuse all the logic. 

                self.fileTab.currentTab = self.enterWidget 

                self.tabChanged() 

                if self.fileTab.currentTab == self.teachWidget: 

                        #the tab change wasn't allowed. 

                        return False 

 

                #ask if the user wants to save 

                if self.changed: 

                        lessonDialogsModule = self._modules.default("active", type="lessonDialogs") 

                        if not lessonDialogsModule.okToClose(parent=self.fileTab.currentTab): 

                                return False 

 

                #really stop 

                self.fileTab.close() 

                # Stop media playing 

                self.enterWidget.mediaDisplay.stop() 

                self.teachWidget.mediaDisplay.stop() 

                self.stopped.send() 

                return True 

 

        def teachListChanged(self, list): 

                # Update results widget 

                self.resultsWidget.updateList(list, "media") 

                self.changed = True 

 

        def toEnterTab(self): 

                self.fileTab.currentTab = self.enterWidget 

 

        def tabChanged(self): 

                """First do checks that apply to all lessons. In case they don't 

                   show any problems, the callback with media specific checks is 

                   called. 

 

                """ 

                #FIXME 3.1: move into separate module since this uses QtWidgets? 

                def callback(): 

                        #media specific checks 

                        for item in self.enterWidget.list["items"]: 

                                if not item.get("question", "") or not item.get("answer", ""): 

                                        QtWidgets.QMessageBox.critical( 

                                                self.teachWidget, 

                                                _("Empty question or answer"), 

                                                _("Please enter at least one question and one answer for every item.") 

                                        ) 

                                        self.fileTab.currentTab = self.enterWidget 

                                        return 

 

                        #everything ok, initiate lesson. 

                        self.teachWidget.initiateLesson(self.enterWidget.list) 

 

                #generic checks 

                lessonDialogsModule = self._modules.default("active", type="lessonDialogs") 

                lessonDialogsModule.onTabChanged(self.fileTab, self.enterWidget, self.teachWidget, callback) 

 

def init(moduleManager): 

        return MediaLessonModule(moduleManager)