| Type: | courseHeroApi |
| Uses (at least one of): |
TranslatorModule >
|
| Requires (at least one of): |
GuiModule >
ButtonRegisterModule > WordsStringParserModule > JavascriptParserModule > LoaderGuiModule > LanguageCodeGuesserModule > MetadataModule > |
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 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 | #! /usr/bin/env python3
# -*- coding: utf-8 -*-
# Copyright 2012-2013, Marten de Vries
#
# 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/>.
API_KEY = "sWHTqm5ZVptpaesh3R9UCnSCf8kaQ3QT"
import urllib.request, urllib.parse, urllib.error
import json
import datetime
import logging
import io
logger = logging.getLogger("courseheroapi")
class CourseHeroApi:
"""See for documentation of the API this communicates with:
http://www.coursehero.com/api/intro.php
"""
def __init__(self, userAgent, parse, getLanguageName, *args, **kwargs):
super().__init__(*args, **kwargs)
self._parse = parse
self._getLanguageName = getLanguageName
self._baseUrl = "https://www.coursehero.com/api/flashcards"
self._opener = urllib.request.build_opener()
self._opener.addheaders = [('User-Agent', userAgent)]
def _open(self, url, **kwargs):
kwargs["api_key"] = API_KEY
fullUrl = self._baseUrl + url + "?" + urllib.parse.urlencode(kwargs)
logger.info("Opening URL: %s" % fullUrl)
return io.TextIOWrapper(self._opener.open(fullUrl), encoding='UTF-8')
def searchSets(self, searchTerm):
try:
fd = self._open("/sets/", query=searchTerm)
except urllib.error.HTTPError as e:
logger.debug(e)
logger.debug(e.read())
return {"data": []}
return json.load(fd)
def downloadSet(self, id):
fd = self._open("/sets/%s/" % id)
data = json.load(fd)["data"]
created = datetime.datetime.fromtimestamp(data["created"])
list = {}
list["title"] = data["title"]
list["items"] = [
{
"id": card["fcid"],
"created": created,
"questions": self._parse(card["term"]),
"answers": self._parse(card["definition"]),
"commentfterAnswering": card["example"],
}
for card in data["flashcards"]
]
return {
"list": list,
"resources": {},
}
def installQtClasses():
global Model, SearchDialog
class Model(QtCore.QAbstractListModel):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._choices = []
def update(self, choices):
"""Choices should be an iterable object of tuples of size two,
with in it first the text to display and second the value to
return by getChoice().
"""
self.beginResetModel()
self._choices = choices
self.endResetModel()
def rowCount(self, parent):
return len(self._choices)
def data(self, index, role):
if not (index.isValid() and role == QtCore.Qt.DisplayRole):
return
return self._choices[index.row()][0]
def getChoice(self, index):
return self._choices[index.row()][1]
class SearchDialog(QtWidgets.QDialog):
searchRequested = QtCore.pyqtSignal()
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._label = QtWidgets.QLabel()
self._label.setWordWrap(True)
self._searchBox = QtWidgets.QLineEdit()
self._searchButton = QtWidgets.QPushButton()
self._searchButton.clicked.connect(self.searchRequested.emit)
self._listView = QtWidgets.QListView()
self._model = Model()
self._listView.setModel(self._model)
self._listView.setSelectionMode(QtWidgets.QAbstractItemView.ExtendedSelection)
self._listView.doubleClicked.connect(self.accept)
buttonBox = QtWidgets.QDialogButtonBox(
QtWidgets.QDialogButtonBox.Cancel | QtWidgets.QDialogButtonBox.Ok,
parent=self
)
buttonBox.accepted.connect(self.accept)
buttonBox.rejected.connect(self.reject)
hbox = QtWidgets.QHBoxLayout()
hbox.addWidget(self._searchBox)
hbox.addWidget(self._searchButton)
l = QtWidgets.QVBoxLayout()
l.addWidget(self._label)
l.addLayout(hbox)
l.addWidget(self._listView)
l.addWidget(buttonBox)
self.setLayout(l)
@property
def chosenResults(self):
return [self._model.getChoice(i) for i in self._listView.selectedIndexes()]
def setResults(self, results):
self._model.update(results)
@property
def searchTerm(self):
return self._searchBox.text()
def retranslate(self):
self._label.setText(_("Enter a search term and press the search button to search coursehero.com for sets. Then select the set or sets you want to import and click OK."))
self._searchBox.setPlaceholderText(_("E.g.: french"))
self._searchButton.setText(_("Search"))
self.setWindowTitle(_("Search coursehero.com"))
def keyPressEvent(self, event):
if event.key() != QtCore.Qt.Key_Return:
#prevent the Ok button from triggering, most people
#would expect it to be the search shortcut. (Which it
#isn't, either.)
return super().keyPressEvent(event)
class CourseHeroApiModule:
def __init__(self, moduleManager, *args, **kwargs):
super().__init__(*args, **kwargs)
self._mm = moduleManager
self.type = "courseHeroApi"
self.requires = (
self._mm.mods(type="ui"),
self._mm.mods(type="buttonRegister"),
self._mm.mods(type="wordsStringParser"),
self._mm.mods(type="loaderGui"),
self._mm.mods(type="languageCodeGuesser"),
self._mm.mods(type="metadata"),
)
self.uses = (
self._mm.mods(type="translator"),
)
self.filesWithTranslations = ("courseHeroApi.py",)
self.priorities = {
"default": 630,
}
@property
def _getLanguageName(self):
return self._modules.default("active", type="languageCodeGuesser").getLanguageName
def enable(self):
global QtCore, QtWidgets
try:
from PyQt5 import QtCore, QtWidgets
except ImportError:
return
installQtClasses()
self._modules = set(self._mm.mods(type="modules")).pop()
self._uiModule = self._modules.default("active", type="ui")
self._buttonRegister = self._modules.default("active", type="buttonRegister")
userAgent = self._modules.default('active', type='metadata').metadata['userAgent']
self._api = CourseHeroApi(userAgent, self._parse, self._getLanguageName)
self._button = self._buttonRegister.registerButton("load-from-internet")
self._button.clicked.handle(self.doImport)
self._button.changePriority.send(self.priorities["default"])
try:
translator = self._modules.default("active", type="translator")
except IndexError:
pass
else:
translator.languageChanged.handle(self._retranslate)
self._retranslate()
self.active = True
def _retranslate(self):
global _
global ngettext
#Install translator
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(_("Import from coursehero.com"))
#Translate all active dialogs
if hasattr(self, "_dialog"):
self._dialog.retranslate()
self._dialog.tab.title = self._dialog.windowTitle()
@property
def _parse(self):
return self._modules.default("active", type="wordsStringParser").parse
def _handleSearch(self):
try:
data = self._api.searchSets(self._dialog.searchTerm)
except urllib.error.URLError as e:
logger.debug(e, exc_info=True)
self._noConnection()
return
self._dialog.setResults([
(result["title"], result["fcsid"])
for result in data["data"]
])
def _noConnection(self):
QtWidgets.QMessageBox.warning(
self._uiModule.qtParent,
_("No coursehero.com connection"),
_("coursehero.com didn't accept the connection. Are you sure that your internet connection works and coursehero.com is online?")
)
def doImport(self):
try:
self._dialog = SearchDialog()
tab = self._uiModule.addCustomTab(self._dialog)
tab.closeRequested.handle(tab.close)
self._dialog.rejected.connect(tab.close)
self._dialog.accepted.connect(tab.close)
self._dialog.searchRequested.connect(self._handleSearch)
self._dialog.tab = tab
self._retranslate()
self._dialog.accepted.connect(self._downloadSelectedList)
for setId in self._dialog.chosenResults:
list = self._api.downloadSet(setId)
try:
self._loadList(list)
except NotImplementedError:
return
except urllib.error.URLError as e:
logger.debug(e, exc_info=True)
self._noConnection()
return
def _downloadSelectedList(self):
try:
for setId in self._dialog.chosenResults:
list = self._api.downloadSet(setId)
try:
self._loadList(list)
except NotImplementedError:
return
except urllib.error.URLError as e:
logger.debug(e, exc_info=True)
self._noConnection()
return
#everything went well
self._uiModule.statusViewer.show(_("The word list was imported from coursehero.com successfully."))
def _loadList(self, list):
self._modules.default("active", type="loaderGui").loadFromLesson("words", list)
def disable(self):
self.active = False
self._buttonRegister.unregisterButton(self._button)
del self._modules
del self._uiModule
del self._buttonRegister
del self._api
del self._button
def init(moduleManager):
return CourseHeroApiModule(moduleManager)
|