# -*- coding: utf-8 -*- # Copyright: Damien Elmes # License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html import time import random import itertools from operator import itemgetter from heapq import * import datetime from anki.utils import ids2str, intTime, fmtTimeSpan from anki.lang import _ from anki.consts import * from anki.hooks import runHook # card types: 0=new, 1=lrn, 2=rev, 3=relrn # queue types: 0=new, 1=(re)lrn, 2=rev, 3=day (re)lrn, # 4=preview, -1=suspended, -2=sibling buried, -3=manually buried # revlog types: 0=lrn, 1=rev, 2=relrn, 3=early review # positive revlog intervals are in days (rev), negative in seconds (lrn) # odue/odid store original due/did when cards moved to filtered deck class Scheduler: name = "std2" haveCustomStudy = True _burySiblingsOnAnswer = True def __init__(self, col): self.col = col self.queueLimit = 50 self.reportLimit = 1000 self.reps = 0 self.today = None self._haveQueues = False self._updateCutoff() def getCard(self): "Pop the next card from the queue. None if finished." self._checkDay() if not self._haveQueues: self.reset() card = self._getCard() if card: self.col.log(card) if not self._burySiblingsOnAnswer: self._burySiblings(card) self.reps += 1 card.startTimer() return card def reset(self): self._updateCutoff() self._resetLrn() self._resetRev() self._resetNew() self._haveQueues = True def answerCard(self, card, ease): self.col.log() assert 1 <= ease <= 4 assert 0 <= card.queue <= 4 self.col.markReview(card) if self._burySiblingsOnAnswer: self._burySiblings(card) self._answerCard(card, ease) self._updateStats(card, 'time', card.timeTaken()) card.mod = intTime() card.usn = self.col.usn() card.flushSched() def _answerCard(self, card, ease): if self._previewingCard(card): self._answerCardPreview(card, ease) return card.reps += 1 if card.queue == 0: # came from the new queue, move to learning card.queue = 1 card.type = 1 # init reps to graduation card.left = self._startingLeft(card) # update daily limit self._updateStats(card, 'new') if card.queue in (1, 3): self._answerLrnCard(card, ease) elif card.queue == 2: self._answerRevCard(card, ease) # update daily limit self._updateStats(card, 'rev') else: assert 0 def _answerCardPreview(self, card, ease): assert 1 <= ease <= 2 if ease == 1: # repeat after delay card.queue = 4 card.due = intTime() + self._previewDelay(card) self.lrnCount += 1 else: # restore original card state and remove from filtered deck self._restorePreviewCard(card) self._removeFromFiltered(card) def counts(self, card=None): counts = [self.newCount, self.lrnCount, self.revCount] if card: idx = self.countIdx(card) counts[idx] += 1 return tuple(counts) def dueForecast(self, days=7): "Return counts over next DAYS. Includes today." daysd = dict(self.col.db.all(""" select due, count() from cards where did in %s and queue = 2 and due between ? and ? group by due order by due""" % self._deckLimit(), self.today, self.today+days-1)) for d in range(days): d = self.today+d if d not in daysd: daysd[d] = 0 # return in sorted order ret = [x[1] for x in sorted(daysd.items())] return ret def countIdx(self, card): if card.queue in (3,4): return 1 return card.queue def answerButtons(self, card): conf = self._cardConf(card) if card.odid and not conf['resched']: return 2 return 4 # Rev/lrn/time daily stats ########################################################################## def _updateStats(self, card, type, cnt=1): key = type+"Today" for g in ([self.col.decks.get(card.did)] + self.col.decks.parents(card.did)): # add g[key][1] += cnt self.col.decks.save(g) def extendLimits(self, new, rev): cur = self.col.decks.current() parents = self.col.decks.parents(cur['id']) children = [self.col.decks.get(did) for (name, did) in self.col.decks.children(cur['id'])] for g in [cur] + parents + children: # add g['newToday'][1] -= new g['revToday'][1] -= rev self.col.decks.save(g) def _walkingCount(self, limFn=None, cntFn=None): tot = 0 pcounts = {} # for each of the active decks for did in self.col.decks.active(): # early alphas were setting the active ids as a str did = int(did) # get the individual deck's limit lim = limFn(self.col.decks.get(did)) if not lim: continue # check the parents parents = self.col.decks.parents(did) for p in parents: # add if missing if p['id'] not in pcounts: pcounts[p['id']] = limFn(p) # take minimum of child and parent lim = min(pcounts[p['id']], lim) # see how many cards we actually have cnt = cntFn(did, lim) # if non-zero, decrement from parent counts for p in parents: pcounts[p['id']] -= cnt # we may also be a parent pcounts[did] = lim - cnt # and add to running total tot += cnt return tot # Deck list ########################################################################## def deckDueList(self): "Returns [deckname, did, rev, lrn, new]" self._checkDay() self.col.decks.recoverOrphans() decks = self.col.decks.all() decks.sort(key=itemgetter('name')) lims = {} data = [] def parent(name): parts = name.split("::") if len(parts) < 2: return None parts = parts[:-1] return "::".join(parts) for deck in decks: # if we've already seen the exact same deck name, remove the # invalid duplicate and reload if deck['name'] in lims: self.col.decks.rem(deck['id'], cardsToo=False, childrenToo=True) return self.deckDueList() p = parent(deck['name']) # new nlim = self._deckNewLimitSingle(deck) if p: if p not in lims: # if parent was missing, this deck is invalid, and we # need to reload the deck list self.col.decks.rem(deck['id'], cardsToo=False, childrenToo=True) return self.deckDueList() nlim = min(nlim, lims[p][0]) new = self._newForDeck(deck['id'], nlim) # learning lrn = self._lrnForDeck(deck['id']) # reviews if p: plim = lims[p][1] else: plim = None rlim = self._deckRevLimitSingle(deck, parentLimit=plim) rev = self._revForDeck(deck['id'], rlim) # save to list data.append([deck['name'], deck['id'], rev, lrn, new]) # add deck as a parent lims[deck['name']] = [nlim, rlim] return data def deckDueTree(self): return self._groupChildren(self.deckDueList()) def _groupChildren(self, grps): # first, split the group names into components for g in grps: g[0] = g[0].split("::") # and sort based on those components grps.sort(key=itemgetter(0)) # then run main function return self._groupChildrenMain(grps) def _groupChildrenMain(self, grps): tree = [] # group and recurse def key(grp): return grp[0][0] for (head, tail) in itertools.groupby(grps, key=key): tail = list(tail) did = None rev = 0 new = 0 lrn = 0 children = [] for c in tail: if len(c[0]) == 1: # current node did = c[1] rev += c[2] lrn += c[3] new += c[4] else: # set new string to tail c[0] = c[0][1:] children.append(c) children = self._groupChildrenMain(children) # tally up children counts for ch in children: lrn += ch[3] new += ch[4] # limit the counts to the deck's limits conf = self.col.decks.confForDid(did) deck = self.col.decks.get(did) if not conf['dyn']: new = max(0, min(new, conf['new']['perDay']-deck['newToday'][1])) tree.append((head, did, rev, lrn, new, children)) return tuple(tree) # Getting the next card ########################################################################## def _getCard(self): "Return the next due card id, or None." # learning card due? c = self._getLrnCard() if c: return c # new first, or time for one? if self._timeForNewCard(): c = self._getNewCard() if c: return c # day learning first and card due? dayLearnFirst = self.col.conf.get("dayLearnFirst", False) c = dayLearnFirst and self._getLrnDayCard() if c: return c # card due for review? c = self._getRevCard() if c: return c # day learning card due? c = not dayLearnFirst and self._getLrnDayCard() if c: return c # new cards left? c = self._getNewCard() if c: return c # collapse or finish return self._getLrnCard(collapse=True) # New cards ########################################################################## def _resetNewCount(self): cntFn = lambda did, lim: self.col.db.scalar(""" select count() from (select 1 from cards where did = ? and queue = 0 limit ?)""", did, lim) self.newCount = self._walkingCount(self._deckNewLimitSingle, cntFn) def _resetNew(self): self._resetNewCount() self._newDids = self.col.decks.active()[:] self._newQueue = [] self._updateNewCardRatio() def _fillNew(self): if self._newQueue: return True if not self.newCount: return False while self._newDids: did = self._newDids[0] lim = min(self.queueLimit, self._deckNewLimit(did)) if lim: # fill the queue with the current did self._newQueue = self.col.db.list(""" select id from cards where did = ? and queue = 0 order by due limit ?""", did, lim) if self._newQueue: self._newQueue.reverse() return True # nothing left in the deck; move to next self._newDids.pop(0) if self.newCount: # if we didn't get a card but the count is non-zero, # we need to check again for any cards that were # removed from the queue but not buried self._resetNew() return self._fillNew() def _getNewCard(self): if self._fillNew(): self.newCount -= 1 return self.col.getCard(self._newQueue.pop()) def _updateNewCardRatio(self): if self.col.conf['newSpread'] == NEW_CARDS_DISTRIBUTE: if self.newCount: self.newCardModulus = ( (self.newCount + self.revCount) // self.newCount) # if there are cards to review, ensure modulo >= 2 if self.revCount: self.newCardModulus = max(2, self.newCardModulus) return self.newCardModulus = 0 def _timeForNewCard(self): "True if it's time to display a new card when distributing." if not self.newCount: return False if self.col.conf['newSpread'] == NEW_CARDS_LAST: return False elif self.col.conf['newSpread'] == NEW_CARDS_FIRST: return True elif self.newCardModulus: return self.reps and self.reps % self.newCardModulus == 0 def _deckNewLimit(self, did, fn=None): if not fn: fn = self._deckNewLimitSingle sel = self.col.decks.get(did) lim = -1 # for the deck and each of its parents for g in [sel] + self.col.decks.parents(did): rem = fn(g) if lim == -1: lim = rem else: lim = min(rem, lim) return lim def _newForDeck(self, did, lim): "New count for a single deck." if not lim: return 0 lim = min(lim, self.reportLimit) return self.col.db.scalar(""" select count() from (select 1 from cards where did = ? and queue = 0 limit ?)""", did, lim) def _deckNewLimitSingle(self, g): "Limit for deck without parent limits." if g['dyn']: return self.reportLimit c = self.col.decks.confForDid(g['id']) return max(0, c['new']['perDay'] - g['newToday'][1]) def totalNewForCurrentDeck(self): return self.col.db.scalar( """ select count() from cards where id in ( select id from cards where did in %s and queue = 0 limit ?)""" % ids2str(self.col.decks.active()), self.reportLimit) # Learning queues ########################################################################## def _resetLrnCount(self): cutoff = intTime() + self.col.conf['collapseTime'] # sub-day self.lrnCount = self.col.db.scalar(""" select count() from (select null from cards where did in %s and queue = 1 and due < ? limit %d)""" % ( self._deckLimit(), self.reportLimit), cutoff) or 0 # day self.lrnCount += self.col.db.scalar(""" select count() from (select null from cards where did in %s and queue = 3 and due <= ? limit %d)""" % (self._deckLimit(), self.reportLimit), self.today) # previews self.lrnCount += self.col.db.scalar(""" select count() from (select null from cards where did in %s and queue = 4 limit %d)""" % (self._deckLimit(), self.reportLimit)) def _resetLrn(self): self._resetLrnCount() self._lrnQueue = [] self._lrnDayQueue = [] self._lrnDids = self.col.decks.active()[:] # sub-day learning def _fillLrn(self): if not self.lrnCount: return False if self._lrnQueue: return True cutoff = intTime() + self.col.conf['collapseTime'] self._lrnQueue = self.col.db.all(""" select due, id from cards where did in %s and queue in (1,4) and due < :lim limit %d""" % (self._deckLimit(), self.reportLimit), lim=cutoff) # as it arrives sorted by did first, we need to sort it self._lrnQueue.sort() return self._lrnQueue def _getLrnCard(self, collapse=False): if self._fillLrn(): cutoff = time.time() if collapse: cutoff += self.col.conf['collapseTime'] if self._lrnQueue[0][0] < cutoff: id = heappop(self._lrnQueue)[1] card = self.col.getCard(id) self.lrnCount -= 1 return card # daily learning def _fillLrnDay(self): if not self.lrnCount: return False if self._lrnDayQueue: return True while self._lrnDids: did = self._lrnDids[0] # fill the queue with the current did self._lrnDayQueue = self.col.db.list(""" select id from cards where did = ? and queue = 3 and due <= ? limit ?""", did, self.today, self.queueLimit) if self._lrnDayQueue: # order r = random.Random() r.seed(self.today) r.shuffle(self._lrnDayQueue) # is the current did empty? if len(self._lrnDayQueue) < self.queueLimit: self._lrnDids.pop(0) return True # nothing left in the deck; move to next self._lrnDids.pop(0) def _getLrnDayCard(self): if self._fillLrnDay(): self.lrnCount -= 1 return self.col.getCard(self._lrnDayQueue.pop()) def _answerLrnCard(self, card, ease): conf = self._lrnConf(card) if card.type in (2,3): type = 2 else: type = 0 # lrnCount was decremented once when card was fetched lastLeft = card.left leaving = False # immediate graduate? if ease == 4: self._rescheduleAsRev(card, conf, True) leaving = True # next step? elif ease == 3: # graduation time? if (card.left%1000)-1 <= 0: self._rescheduleAsRev(card, conf, False) leaving = True else: self._moveToNextStep(card, conf) elif ease == 2: self._repeatStep(card, conf) else: # back to first step self._moveToFirstStep(card, conf) self._logLrn(card, ease, conf, leaving, type, lastLeft) def _updateRevIvlOnFail(self, card, conf): card.lastIvl = card.ivl card.ivl = self._lapseIvl(card, conf) def _moveToFirstStep(self, card, conf): card.left = self._startingLeft(card) # relearning card? if card.type == 3: self._updateRevIvlOnFail(card, conf) return self._rescheduleLrnCard(card, conf) def _moveToNextStep(self, card, conf): # decrement real left count and recalculate left today left = (card.left % 1000) - 1 card.left = self._leftToday(conf['delays'], left)*1000 + left self._rescheduleLrnCard(card, conf) def _repeatStep(self, card, conf): delay = self._delayForRepeatingGrade(conf, card.left) self._rescheduleLrnCard(card, conf, delay=delay) def _rescheduleLrnCard(self, card, conf, delay=None): # normal delay for the current step? if delay is None: delay = self._delayForGrade(conf, card.left) if card.due < time.time(): # not collapsed; add some randomness delay *= random.uniform(1, 1.25) card.due = int(time.time() + delay) # due today? if card.due < self.dayCutoff: card.queue = 1 if card.due < (intTime() + self.col.conf['collapseTime']): self.lrnCount += 1 # if the queue is not empty and there's nothing else to do, make # sure we don't put it at the head of the queue and end up showing # it twice in a row if self._lrnQueue and not self.revCount and not self.newCount: smallestDue = self._lrnQueue[0][0] card.due = max(card.due, smallestDue+1) heappush(self._lrnQueue, (card.due, card.id)) else: # the card is due in one or more days, so we need to use the # day learn queue ahead = ((card.due - self.dayCutoff) // 86400) + 1 card.due = self.today + ahead card.queue = 3 return delay def _delayForGrade(self, conf, left): left = left % 1000 try: delay = conf['delays'][-left] except IndexError: if conf['delays']: delay = conf['delays'][0] else: # user deleted final step; use dummy value delay = 1 return delay*60 def _delayForRepeatingGrade(self, conf, left): # halfway between last and next delay1 = self._delayForGrade(conf, left) delay2 = self._delayForGrade(conf, left-1) avg = (delay1+max(delay1, delay2))//2 return avg def _lrnConf(self, card): if card.type in (2, 3): return self._lapseConf(card) else: return self._newConf(card) def _rescheduleAsRev(self, card, conf, early): lapse = card.type in (2,3) if lapse: self._rescheduleGraduatingLapse(card) else: self._rescheduleNew(card, conf, early) # if we were dynamic, graduating means moving back to the old deck if card.odid: self._removeFromFiltered(card) def _rescheduleGraduatingLapse(self, card): card.due = self.today+card.ivl card.queue = 2 card.type = 2 def _startingLeft(self, card): if card.type == 2: conf = self._lapseConf(card) else: conf = self._lrnConf(card) tot = len(conf['delays']) tod = self._leftToday(conf['delays'], tot) return tot + tod*1000 def _leftToday(self, delays, left, now=None): "The number of steps that can be completed by the day cutoff." if not now: now = intTime() delays = delays[-left:] ok = 0 for i in range(len(delays)): now += delays[i]*60 if now > self.dayCutoff: break ok = i return ok+1 def _graduatingIvl(self, card, conf, early, fuzz=True): if card.type in (2,3): return card.ivl if not early: # graduate ideal = conf['ints'][0] else: # early remove ideal = conf['ints'][1] if fuzz: ideal = self._fuzzedIvl(ideal) return ideal def _rescheduleNew(self, card, conf, early): "Reschedule a new card that's graduated for the first time." card.ivl = self._graduatingIvl(card, conf, early) card.due = self.today+card.ivl card.factor = conf['initialFactor'] card.type = card.queue = 2 def _logLrn(self, card, ease, conf, leaving, type, lastLeft): lastIvl = -(self._delayForGrade(conf, lastLeft)) ivl = card.ivl if leaving else -(self._delayForGrade(conf, card.left)) def log(): self.col.db.execute( "insert into revlog values (?,?,?,?,?,?,?,?,?)", int(time.time()*1000), card.id, self.col.usn(), ease, ivl, lastIvl, card.factor, card.timeTaken(), type) try: log() except: # duplicate pk; retry in 10ms time.sleep(0.01) log() def _lrnForDeck(self, did): cnt = self.col.db.scalar( """ select count() from (select null from cards where did = ? and queue = 1 and due < ? limit ?)""", did, intTime() + self.col.conf['collapseTime'], self.reportLimit) or 0 return cnt + self.col.db.scalar( """ select count() from (select null from cards where did = ? and queue = 3 and due <= ? limit ?)""", did, self.today, self.reportLimit) # Reviews ########################################################################## def _currentRevLimit(self): d = self.col.decks.get(self.col.decks.selected(), default=False) return self._deckRevLimitSingle(d) def _deckRevLimitSingle(self, d, parentLimit=None): # invalid deck selected? if not d: return 0 if d['dyn']: return self.reportLimit c = self.col.decks.confForDid(d['id']) lim = max(0, c['rev']['perDay'] - d['revToday'][1]) if parentLimit is not None: return min(parentLimit, lim) elif '::' not in d['name']: return lim else: for parent in self.col.decks.parents(d['id']): # pass in dummy parentLimit so we don't do parent lookup again lim = min(lim, self._deckRevLimitSingle(parent, parentLimit=lim)) return lim def _revForDeck(self, did, lim): dids = [did] + [x[1] for x in self.col.decks.children(did)] lim = min(lim, self.reportLimit) return self.col.db.scalar( """ select count() from (select 1 from cards where did in %s and queue = 2 and due <= ? limit ?)""" % ids2str(dids), self.today, lim) def _resetRevCount(self): lim = self._currentRevLimit() self.revCount = self.col.db.scalar(""" select count() from (select id from cards where did in %s and queue = 2 and due <= ? limit %d)""" % ( ids2str(self.col.decks.active()), lim), self.today) def _resetRev(self): self._resetRevCount() self._revQueue = [] def _fillRev(self): if self._revQueue: return True if not self.revCount: return False lim = min(self.queueLimit, self._currentRevLimit()) if lim: self._revQueue = self.col.db.list(""" select id from cards where did in %s and queue = 2 and due <= ? order by due limit ?""" % (ids2str(self.col.decks.active())), self.today, lim) if self._revQueue: if self.col.decks.get(self.col.decks.selected(), default=False)['dyn']: # dynamic decks need due order preserved self._revQueue.reverse() else: # fixme: as soon as a card is answered, this is no longer consistent r = random.Random() r.seed(self.today) r.shuffle(self._revQueue) return True if self.revCount: # if we didn't get a card but the count is non-zero, # we need to check again for any cards that were # removed from the queue but not buried self._resetRev() return self._fillRev() def _getRevCard(self): if self._fillRev(): self.revCount -= 1 return self.col.getCard(self._revQueue.pop()) def totalRevForCurrentDeck(self): return self.col.db.scalar( """ select count() from cards where id in ( select id from cards where did in %s and queue = 2 and due <= ? limit ?)""" % ids2str(self.col.decks.active()), self.today, self.reportLimit) # Answering a review card ########################################################################## def _answerRevCard(self, card, ease): delay = 0 early = card.odid and (card.odue > self.today) type = early and 3 or 2 if ease == 1: delay = self._rescheduleLapse(card) else: self._rescheduleRev(card, ease, early) self._logRev(card, ease, delay, type) def _rescheduleLapse(self, card): conf = self._lapseConf(card) card.lapses += 1 card.factor = max(1300, card.factor-200) if conf['delays']: card.type = 3 delay = self._moveToFirstStep(card, conf) else: # no relearning steps self._updateRevIvlOnFail(card, conf) self._rescheduleAsRev(card, conf, early=False) delay = 0 # if suspended as a leech, nothing to do if self._checkLeech(card, conf) and card.queue == -1: return 0 return delay def _lapseIvl(self, card, conf): due = card.odue or card.due elapsed = card.ivl - (due - self.today) ivl = min(elapsed, card.ivl) ivl = max(1, conf['minInt'], ivl*conf['mult']) return ivl def _rescheduleRev(self, card, ease, early): # update interval card.lastIvl = card.ivl if early: self._updateEarlyRevIvl(card, ease) else: self._updateRevIvl(card, ease) # then the rest card.factor = max(1300, card.factor+[-150, 0, 150][ease-2]) card.due = self.today + card.ivl # card leaves filtered deck self._removeFromFiltered(card) def _logRev(self, card, ease, delay, type): def log(): self.col.db.execute( "insert into revlog values (?,?,?,?,?,?,?,?,?)", int(time.time()*1000), card.id, self.col.usn(), ease, -delay or card.ivl, card.lastIvl, card.factor, card.timeTaken(), type) try: log() except: # duplicate pk; retry in 10ms time.sleep(0.01) log() # Interval management ########################################################################## def _nextRevIvl(self, card, ease, fuzz): "Next review interval for CARD, given EASE." delay = self._daysLate(card) conf = self._revConf(card) fct = card.factor / 1000 ivl2 = self._constrainedIvl((card.ivl + delay // 4) * 1.2, conf, card.ivl, fuzz) if ease == 2: return ivl2 ivl3 = self._constrainedIvl((card.ivl + delay // 2) * fct, conf, ivl2, fuzz) if ease == 3: return ivl3 ivl4 = self._constrainedIvl( (card.ivl + delay) * fct * conf['ease4'], conf, ivl3, fuzz) return ivl4 def _fuzzedIvl(self, ivl): min, max = self._fuzzIvlRange(ivl) return random.randint(min, max) def _fuzzIvlRange(self, ivl): if ivl < 2: return [1, 1] elif ivl == 2: return [2, 3] elif ivl < 7: fuzz = int(ivl*0.25) elif ivl < 30: fuzz = max(2, int(ivl*0.15)) else: fuzz = max(4, int(ivl*0.05)) # fuzz at least a day fuzz = max(fuzz, 1) return [ivl-fuzz, ivl+fuzz] def _constrainedIvl(self, ivl, conf, prev, fuzz): ivl = int(ivl * conf.get('ivlFct', 1)) if fuzz: ivl = self._fuzzedIvl(ivl) ivl = min(ivl, conf['maxIvl']) ivl = max(ivl, prev+1, 1) return int(ivl) def _daysLate(self, card): "Number of days later than scheduled." due = card.odue if card.odid else card.due return max(0, self.today - due) def _updateRevIvl(self, card, ease): card.ivl = self._nextRevIvl(card, ease, fuzz=True) def _updateEarlyRevIvl(self, card, ease): card.ivl = self._earlyReviewIvl(card, ease) # next interval for card when answered early+correctly def _earlyReviewIvl(self, card, ease): assert card.odid and card.type == 2 assert card.factor assert ease > 1 elapsed = card.ivl - (card.odue - self.today) conf = self._revConf(card) easyBonus = 0 # early 3/4 reviews shouldn't decrease previous interval minNewIvl = 1 if ease == 2: factor = 1.2 # hard cards shouldn't have their interval decreased by more than 50% minNewIvl = 0.5 elif ease == 3: factor = card.factor / 1000 else: # ease == 4: factor = card.factor / 1000 * conf['ease4'] # add an extra day, so early reviews have an easy interval nominally # different from the good answer easyBonus = 1 ivl = max(elapsed * factor, 1) # cap interval decreases ivl = max(card.ivl*minNewIvl+easyBonus, ivl) ivl = self._constrainedIvl(ivl, conf, prev=0, fuzz=False) return ivl # Dynamic deck handling ########################################################################## def rebuildDyn(self, did=None): "Rebuild a dynamic deck." did = did or self.col.decks.selected() deck = self.col.decks.get(did) assert deck['dyn'] # move any existing cards back first, then fill self.emptyDyn(did) cnt = self._fillDyn(deck) if not cnt: return # and change to our new deck self.col.decks.select(did) return cnt def _fillDyn(self, deck): start = -100000 total = 0 for search, limit, order in deck['terms']: orderlimit = self._dynOrder(order, limit) if search.strip(): search = "(%s)" % search search = "%s -is:suspended -is:buried -deck:filtered" % search try: ids = self.col.findCards(search, order=orderlimit) except: return total # move the cards over self.col.log(deck['id'], ids) self._moveToDyn(deck['id'], ids, start=start+total) total += len(ids) return total def emptyDyn(self, did, lim=None): if not lim: lim = "did = %s" % did self.col.log(self.col.db.list("select id from cards where %s" % lim)) # update queue in preview case self.col.db.execute(""" update cards set did = odid, %s, due = odue, odue = 0, odid = 0, usn = ? where %s""" % ( self._restoreQueueSnippet, lim), self.col.usn()) def remFromDyn(self, cids): self.emptyDyn(None, "id in %s and odid" % ids2str(cids)) def _dynOrder(self, o, l): if o == DYN_OLDEST: t = "(select max(id) from revlog where cid=c.id)" elif o == DYN_RANDOM: t = "random()" elif o == DYN_SMALLINT: t = "ivl" elif o == DYN_BIGINT: t = "ivl desc" elif o == DYN_LAPSES: t = "lapses desc" elif o == DYN_ADDED: t = "n.id" elif o == DYN_REVADDED: t = "n.id desc" elif o == DYN_DUE: t = "c.due" elif o == DYN_DUEPRIORITY: t = "(case when queue=2 and due <= %d then (ivl / cast(%d-due+0.001 as real)) else 100000+due end)" % ( self.today, self.today) else: # if we don't understand the term, default to due order t = "c.due" return t + " limit %d" % l def _moveToDyn(self, did, ids, start=-100000): deck = self.col.decks.get(did) data = [] u = self.col.usn() due = start for id in ids: data.append((did, due, u, id)) due += 1 queue = "" if not deck['resched']: queue = ",queue=2" query = """ update cards set odid = did, odue = due, did = ?, due = ?, usn = ? %s where id = ? """ % queue self.col.db.executemany(query, data) def _removeFromFiltered(self, card): if card.odid: card.did = card.odid card.odue = 0 card.odid = 0 def _restorePreviewCard(self, card): assert card.odid card.due = card.odue # learning and relearning cards may be seconds-based or day-based; # other types map directly to queues if card.type in (1, 3): if card.odue > 1000000000: card.queue = 1 else: card.queue = 3 else: card.queue = card.type # Leeches ########################################################################## def _checkLeech(self, card, conf): "Leech handler. True if card was a leech." lf = conf['leechFails'] if not lf: return # if over threshold or every half threshold reps after that if (card.lapses >= lf and (card.lapses-lf) % (max(lf // 2, 1)) == 0): # add a leech tag f = card.note() f.addTag("leech") f.flush() # handle a = conf['leechAction'] if a == 0: card.queue = -1 # notify UI runHook("leech", card) return True # Tools ########################################################################## def _cardConf(self, card): return self.col.decks.confForDid(card.did) def _newConf(self, card): conf = self._cardConf(card) # normal deck if not card.odid: return conf['new'] # dynamic deck; override some attributes, use original deck for others oconf = self.col.decks.confForDid(card.odid) return dict( # original deck ints=oconf['new']['ints'], initialFactor=oconf['new']['initialFactor'], bury=oconf['new'].get("bury", True), delays=oconf['new']['delays'], # overrides separate=conf['separate'], order=NEW_CARDS_DUE, perDay=self.reportLimit ) def _lapseConf(self, card): conf = self._cardConf(card) # normal deck if not card.odid: return conf['lapse'] # dynamic deck; override some attributes, use original deck for others oconf = self.col.decks.confForDid(card.odid) return dict( # original deck minInt=oconf['lapse']['minInt'], leechFails=oconf['lapse']['leechFails'], leechAction=oconf['lapse']['leechAction'], mult=oconf['lapse']['mult'], delays=oconf['lapse']['delays'], # overrides resched=conf['resched'], ) def _revConf(self, card): conf = self._cardConf(card) # normal deck if not card.odid: return conf['rev'] # dynamic deck return self.col.decks.confForDid(card.odid)['rev'] def _deckLimit(self): return ids2str(self.col.decks.active()) def _previewingCard(self, card): conf = self._cardConf(card) return conf['dyn'] and not conf['resched'] def _previewDelay(self, card): return self._cardConf(card).get("previewDelay", 10)*60 # Daily cutoff ########################################################################## def _updateCutoff(self): oldToday = self.today # days since col created self.today = int((time.time() - self.col.crt) // 86400) # end of day cutoff self.dayCutoff = self._dayCutoff() if oldToday != self.today: self.col.log(self.today, self.dayCutoff) # update all daily counts, but don't save decks to prevent needless # conflicts. we'll save on card answer instead def update(g): for t in "new", "rev", "lrn", "time": key = t+"Today" if g[key][0] != self.today: g[key] = [self.today, 0] for deck in self.col.decks.all(): update(deck) # unbury if the day has rolled over unburied = self.col.conf.get("lastUnburied", 0) if unburied < self.today: self.unburyCards() self.col.conf['lastUnburied'] = self.today def _checkDay(self): # check if the day has rolled over if time.time() > self.dayCutoff: self.reset() def _dayCutoff(self): rolloverTime = self.col.conf.get("rollover", 4) if rolloverTime < 0: rolloverTime = 24+rolloverTime date = datetime.datetime.today() date = date.replace(hour=rolloverTime, minute=0, second=0, microsecond=0) if date < datetime.datetime.today(): date = date + datetime.timedelta(days=1) stamp = time.mktime(date.timetuple()) return stamp # Deck finished state ########################################################################## def finishedMsg(self): return (""+_( "Congratulations! You have finished this deck for now.")+ "

" + self._nextDueMsg()) def _nextDueMsg(self): line = [] # the new line replacements are so we don't break translations # in a point release if self.revDue(): line.append(_("""\ Today's review limit has been reached, but there are still cards waiting to be reviewed. For optimum memory, consider increasing the daily limit in the options.""").replace("\n", " ")) if self.newDue(): line.append(_("""\ There are more new cards available, but the daily limit has been reached. You can increase the limit in the options, but please bear in mind that the more new cards you introduce, the higher your short-term review workload will become.""").replace("\n", " ")) if self.haveBuried(): if self.haveCustomStudy: now = " " + _("To see them now, click the Unbury button below.") else: now = "" line.append(_("""\ Some related or buried cards were delayed until a later session.""")+now) if self.haveCustomStudy and not self.col.decks.current()['dyn']: line.append(_("""\ To study outside of the normal schedule, click the Custom Study button below.""")) return "

".join(line) def revDue(self): "True if there are any rev cards due." return self.col.db.scalar( ("select 1 from cards where did in %s and queue = 2 " "and due <= ? limit 1") % self._deckLimit(), self.today) def newDue(self): "True if there are any new cards due." return self.col.db.scalar( ("select 1 from cards where did in %s and queue = 0 " "limit 1") % self._deckLimit()) def haveBuriedSiblings(self): sdids = ids2str(self.col.decks.active()) cnt = self.col.db.scalar( "select 1 from cards where queue = -2 and did in %s limit 1" % sdids) return not not cnt def haveManuallyBuried(self): sdids = ids2str(self.col.decks.active()) cnt = self.col.db.scalar( "select 1 from cards where queue = -3 and did in %s limit 1" % sdids) return not not cnt def haveBuried(self): return self.haveManuallyBuried() or self.haveBuriedSiblings() # Next time reports ########################################################################## def nextIvlStr(self, card, ease, short=False): "Return the next interval for CARD as a string." ivl = self.nextIvl(card, ease) if not ivl: return _("(end)") s = fmtTimeSpan(ivl, short=short) if ivl < self.col.conf['collapseTime']: s = "<"+s return s def nextIvl(self, card, ease): "Return the next interval for CARD, in seconds." # preview mode? if self._previewingCard(card): if ease == 1: return self._previewDelay(card) return 0 # (re)learning? if card.queue in (0,1,3): return self._nextLrnIvl(card, ease) elif ease == 1: # lapse conf = self._lapseConf(card) if conf['delays']: return conf['delays'][0]*60 return self._lapseIvl(card, conf)*86400 else: # review early = card.odid and (card.odue > self.today) if early: return self._earlyReviewIvl(card, ease)*86400 else: return self._nextRevIvl(card, ease, fuzz=False)*86400 # this isn't easily extracted from the learn code def _nextLrnIvl(self, card, ease): if card.queue == 0: card.left = self._startingLeft(card) conf = self._lrnConf(card) if ease == 1: # fail return self._delayForGrade(conf, len(conf['delays'])) elif ease == 2: return self._delayForRepeatingGrade(conf, card.left) elif ease == 4: return self._graduatingIvl(card, conf, True, fuzz=False) * 86400 else: # ease == 3 left = card.left%1000 - 1 if left <= 0: # graduate return self._graduatingIvl(card, conf, False, fuzz=False) * 86400 else: return self._delayForGrade(conf, left) # Suspending & burying ########################################################################## # learning and relearning cards may be seconds-based or day-based; # other types map directly to queues _restoreQueueSnippet = """ queue = (case when type in (1,3) then (case when (case when odue then odue else due end) > 1000000000 then 1 else 3 end) else type end) """ def suspendCards(self, ids): "Suspend cards." self.col.log(ids) self.col.db.execute( "update cards set queue=-1,mod=?,usn=? where id in "+ ids2str(ids), intTime(), self.col.usn()) def unsuspendCards(self, ids): "Unsuspend cards." self.col.log(ids) self.col.db.execute( ("update cards set %s,mod=?,usn=? " "where queue = -1 and id in %s") % (self._restoreQueueSnippet, ids2str(ids)), intTime(), self.col.usn()) def buryCards(self, cids, manual=True): queue = manual and -3 or -2 self.col.log(cids) self.col.db.execute(""" update cards set queue=?,mod=?,usn=? where id in """+ids2str(cids), queue, intTime(), self.col.usn()) def buryNote(self, nid): "Bury all cards for note until next session." cids = self.col.db.list( "select id from cards where nid = ? and queue >= 0", nid) self.buryCards(cids) def unburyCards(self): "Unbury all buried cards in all decks." self.col.log( self.col.db.list("select id from cards where queue in (-2, -3)")) self.col.db.execute( "update cards set %s where queue in (-2, -3)" % self._restoreQueueSnippet) def unburyCardsForDeck(self, type="all"): if type == "all": queue = "queue in (-2, -3)" elif type == "manual": queue = "queue = -3" elif type == "siblings": queue = "queue = -2" else: raise Exception("unknown type") sids = ids2str(self.col.decks.active()) self.col.log( self.col.db.list("select id from cards where %s and did in %s" % (queue, sids))) self.col.db.execute( "update cards set mod=?,usn=?,%s where %s and did in %s" % (self._restoreQueueSnippet, queue, sids), intTime(), self.col.usn()) # Sibling spacing ########################################################################## def _burySiblings(self, card): toBury = [] nconf = self._newConf(card) buryNew = nconf.get("bury", True) rconf = self._revConf(card) buryRev = rconf.get("bury", True) # loop through and remove from queues for cid,queue in self.col.db.execute(""" select id, queue from cards where nid=? and id!=? and (queue=0 or (queue=2 and due<=?))""", card.nid, card.id, self.today): if queue == 2: if buryRev: toBury.append(cid) # if bury disabled, we still discard to give same-day spacing try: self._revQueue.remove(cid) except ValueError: pass else: # if bury disabled, we still discard to give same-day spacing if buryNew: toBury.append(cid) try: self._newQueue.remove(cid) except ValueError: pass # then bury if toBury: self.buryCards(toBury, manual=False) # Resetting ########################################################################## def forgetCards(self, ids): "Put cards at the end of the new queue." self.remFromDyn(ids) self.col.db.execute( "update cards set type=0,queue=0,ivl=0,due=0,odue=0,factor=?" " where id in "+ids2str(ids), STARTING_FACTOR) pmax = self.col.db.scalar( "select max(due) from cards where type=0") or 0 # takes care of mod + usn self.sortCards(ids, start=pmax+1) self.col.log(ids) def reschedCards(self, ids, imin, imax): "Put cards in review queue with a new interval in days (min, max)." d = [] t = self.today mod = intTime() for id in ids: r = random.randint(imin, imax) d.append(dict(id=id, due=r+t, ivl=max(1, r), mod=mod, usn=self.col.usn(), fact=STARTING_FACTOR)) self.remFromDyn(ids) self.col.db.executemany(""" update cards set type=2,queue=2,ivl=:ivl,due=:due,odue=0, usn=:usn,mod=:mod,factor=:fact where id=:id""", d) self.col.log(ids) def resetCards(self, ids): "Completely reset cards for export." sids = ids2str(ids) # we want to avoid resetting due number of existing new cards on export nonNew = self.col.db.list( "select id from cards where id in %s and (queue != 0 or type != 0)" % sids) # reset all cards self.col.db.execute( "update cards set reps=0,lapses=0,odid=0,odue=0,queue=0" " where id in %s" % sids ) # and forget any non-new cards, changing their due numbers self.forgetCards(nonNew) self.col.log(ids) # Repositioning new cards ########################################################################## def sortCards(self, cids, start=1, step=1, shuffle=False, shift=False): scids = ids2str(cids) now = intTime() nids = [] nidsSet = set() for id in cids: nid = self.col.db.scalar("select nid from cards where id = ?", id) if nid not in nidsSet: nids.append(nid) nidsSet.add(nid) if not nids: # no new cards return # determine nid ordering due = {} if shuffle: random.shuffle(nids) for c, nid in enumerate(nids): due[nid] = start+c*step high = start+c*step # shift? if shift: low = self.col.db.scalar( "select min(due) from cards where due >= ? and type = 0 " "and id not in %s" % scids, start) if low is not None: shiftby = high - low + 1 self.col.db.execute(""" update cards set mod=?, usn=?, due=due+? where id not in %s and due >= ? and queue = 0""" % scids, now, self.col.usn(), shiftby, low) # reorder cards d = [] for id, nid in self.col.db.execute( "select id, nid from cards where type = 0 and id in "+scids): d.append(dict(now=now, due=due[nid], usn=self.col.usn(), cid=id)) self.col.db.executemany( "update cards set due=:due,mod=:now,usn=:usn where id = :cid", d) def randomizeCards(self, did): cids = self.col.db.list("select id from cards where did = ?", did) self.sortCards(cids, shuffle=True) def orderCards(self, did): cids = self.col.db.list("select id from cards where did = ? order by id", did) self.sortCards(cids) def resortConf(self, conf): for did in self.col.decks.didsForConf(conf): if conf['new']['order'] == 0: self.randomizeCards(did) else: self.orderCards(did) # for post-import def maybeRandomizeDeck(self, did=None): if not did: did = self.col.decks.selected() conf = self.col.decks.confForDid(did) # in order due? if conf['new']['order'] == NEW_CARDS_RANDOM: self.randomizeCards(did) # Changing scheduler versions ########################################################################## def _emptyAllFiltered(self): self.col.db.execute(""" update cards set did = odid, queue = (case when type = 1 then 0 when type = 3 then 2 else type end), type = (case when type = 1 then 0 when type = 3 then 2 else type end), due = odue, odue = 0, odid = 0, usn = ? where odid != 0""", self.col.usn()) def _removeAllFromLearning(self): # remove review cards from relearning self.col.db.execute(""" update cards set due = odue, queue = 2, mod = %d, usn = %d, odue = 0 where queue in (1,3) and type in (2, 3) """ % (intTime(), self.col.usn())) # remove new cards from learning self.forgetCards(self.col.db.list( "select id from cards where queue in (1,3)")) # v1 doesn't support buried/suspended (re)learning cards def _resetSuspendedLearning(self): self.col.db.execute(""" update cards set type = (case when type = 1 then 0 when type in (2, 3) then 2 else type end), due = (case when odue then odue else due end), odue = 0, mod = %d, usn = %d where queue < 0""" % (intTime(), self.col.usn())) # no 'manually buried' queue in v1 def _moveManuallyBuried(self): self.col.db.execute("update cards set queue=-2,mod=%d where queue=-3" % intTime()) def moveToV1(self): self._emptyAllFiltered() self._removeAllFromLearning() self._moveManuallyBuried() self._resetSuspendedLearning() def moveToV2(self): self._emptyAllFiltered() self._removeAllFromLearning()