sibling_spacing.py

#!/usr/bin/python
#-*- coding: utf-8 -*-
# ---------------------------------------------------------------------------
# Sibling Spacing is an addon for Anki 2 - http://ankisrs.net
# ---------------------------------------------------------------------------
# Author:      Andreas Klauer (Andreas Klauer@metamorpher.de)
# Version:     0.01 (2013-02-22)
# License:     GPL
# ---------------------------------------------------------------------------

# --- Imports: ---

from anki.hooks import addHook, wrap
from aqt import *
from aqt.utils import showInfo

# --- Constants ---

lookBehindPercent = 0.25
boostPercent = 0.25

# --- Globals: ---

enabled = True
debug = True

# --- Functions: ---

def siblingIvl(self, card, idealIvl, _old):
    origIvl = _old(self, card, idealIvl)

    if not enabled:
        return origIvl

    ivl = origIvl

    # Penalty
    minIvl = self.col.db.scalar('''SELECT MIN(ivl) FROM cards WHERE ivl > 0 AND nid = ? AND id != ? AND queue = 2''',
                                card.nid, card.id)

    #while minIvl and minIvl > 0 and ivl > minIvl*4:
    #    ivl = max(1, int(ivl/2.0))

    # Boost
    delta = max(1, int(ivl * lookBehindPercent))
    boost = max(1, int(ivl * boostPercent))

    siblings = True

    while siblings:
        siblings = self.col.db.scalar('''SELECT count() FROM cards WHERE due >= ? AND due <= ? AND nid = ? AND id != ? AND queue = 2''',
                                      self.today + ivl - delta, self.today + ivl, card.nid, card.id)
        if siblings:
            ivl += boost

    if debug:
        if minIvl and minIvl > 0:
            print "Sibling Spacing %d%+d = %d days for card %d (sibling has %d days)" % (origIvl,ivl-origIvl,ivl,card.id,minIvl,)
        else:
            print "Sibling Spacing == %d days for card %d without visible siblings" % (ivl,card.id,)

    return ivl

def toggle():
    global enabled

    enabled = not enabled

    if enabled:
        showInfo("Sibling Spacing is now ON")
    else:
        showInfo("Sibling Spacing is now OFF")

def toggle_debug():
    global debug

    debug = not debug

    if debug:
        showInfo("Sibling Spacing Debug is now ON")
    else:
        showInfo("Sibling Spacing Debug is now OFF")

def siblingMenu():
    '''Extend the addon menu with toggle.'''
    m = None

    for action in mw.form.menuPlugins.actions():
        menu = action.menu()
        if menu and menu.title() == "sibling_spacing":
            m = menu
            break

    if not m:
        return

    a = QAction(_("Toggle ON/OFF..."), mw)
    mw.connect(a, SIGNAL("triggered()"), toggle)
    m.addAction(a)
    a = QAction(_("Debug ON/OFF..."), mw)
    mw.connect(a, SIGNAL("triggered()"), toggle_debug)
    m.addAction(a)

def profileLoaded():
    # add menu entry
    mw.addonManager.rebuildAddonsMenu = wrap(mw.addonManager.rebuildAddonsMenu,
                                             siblingMenu)
    mw.addonManager.rebuildAddonsMenu()

    # add scheduler
    anki.sched.Scheduler._adjRevIvl = wrap(anki.sched.Scheduler._adjRevIvl,
                                           siblingIvl, "around")

# --- Hooks: ---

addHook("profileLoaded", profileLoaded)

# --- End of file. ---