zz.py

# imports & arabtrans {{{1

from browser import document as d
from browser import html as t
from browser import window as w
from browser import bind
from browser.local_storage import storage
from browser.timer import set_timeout, set_interval
import time

__arabtrans = str.maketrans('0123456789', '٠١٢٣٤٥٦٧٨٩')
def arabnum(n):
  return str(n).translate(__arabtrans)

# url parameters {{{1

initialparams = '&zz' #&nolinebreaks'
otherparams = initialparams

def update_otherparams():
  global otherparams
  otherparams = initialparams
  otherparams += '&mv=' + (storage['mvbtns'] if 'mvbtns' in storage else 'b')
  otherparams += '&by=' + (storage['fbrate'] if 'fbrate' in storage else 'l')
  otherparams += '' if 'dark' not in storage else '&d' if storage['dark'] == 'Y' else '&l'
  otherparams += '&c=n' if load_bool('notajweed') else ''
  otherparams += '&q=imla' if load_bool('imla') else ''

@bind(d['free'], 'click')
def __free_click(ev):
  w.open('/recite/?' + otherparams[4:], '_blank')  # [4:] to remove &zz& from the start

# local storage {{{1

def update_prefs():
  # mvbtns
  mv = storage['mvbtns'] if 'mvbtns' in storage else 'b'
  d['mvbtns_' + mv].style.display = 'inline-block'
  # fbrate
  fb = storage['fbrate'] if 'fbrate' in storage else 'l'
  d['fbrate_' + fb].style.display = 'inline-block'
  #
  # checkboxes
  if 'imla' in storage:        d['imla_chk'].checked = True
  if 'notajweed' in storage:   d['taj_chk'].checked = False
  if 'noquick' in storage:     d['quick_chk'].checked = False
  # darkmode: following the system, unless overriden
  if 'dark' in storage:        d['dark_chk'].checked = storage['dark'] == 'Y'
  else: d['dark_chk'].checked = w.matchMedia('(prefers-color-scheme: dark)').matches
  #
  # warning
  if 'warn' in storage:
    hide_warning(None)


def load_bool(name):
  return name in storage and bool(storage[name])

def store_bool(name, b=True):
  if b:
    storage[name] = "Y"
  else:
    if name in storage:
      del storage[name]

# static data: name, lengths, and rukus_of_sura {{{1

FIRST_TIME_INTERVAL = 6

names = [ 'الفاتحة', 'البقرة', 'آل عمران', 'النساء', 'المائدة', 'الأنعام', 'الأعراف', 'الأنفال', 'التوبة', 'يونس', 'هود', 'يوسف', 'الرعد', 'إبراهيم', 'الحجر', 'النحل', 'الإسراء', 'الكهف', 'مريم', 'طه', 'الأنبياء', 'الحج', 'المؤمنون', 'النور', 'الفرقان', 'الشعراء', 'النمل', 'القصص', 'العنكبوت', 'الروم', 'لقمان', 'السجدة', 'الأحزاب', 'سبأ', 'فاطر', 'يس', 'الصافات', 'ص', 'الزمر', 'غافر', 'فصلت', 'الشورى', 'الزخرف', 'الدخان', 'الجاثية', 'الأحقاف', 'محمد', 'الفتح', 'الحجرات', 'ق', 'الذاريات', 'الطور', 'النجم', 'القمر', 'الرحمن', 'الواقعة', 'الحديد', 'المجادلة', 'الحشر', 'الممتحنة', 'الصف', 'الجمعة', 'المنافقون', 'التغابن', 'الطلاق', 'التحريم', 'الملك', 'القلم', 'الحاقة', 'المعارج', 'نوح', 'الجن', 'المزمل', 'المدثر', 'القيامة', 'الإنسان', 'المرسلات', 'النبأ', 'النازعات', 'عبس', 'التكوير', 'الانفطار', 'المطففين', 'الانشقاق', 'البروج', 'الطارق', 'الأعلى', 'الغاشية', 'الفجر', 'البلد', 'الشمس', 'الليل', 'الضحى', 'الشرح', 'التين', 'العلق', 'القدر', 'البينة', 'الزلزلة', 'العاديات', 'القارعة', 'التكاثر', 'العصر', 'الهمزة', 'الفيل', 'قريش', 'الماعون', 'الكوثر', 'الكافرون', 'النصر', 'المسد', 'الإخلاص', 'الفلق', 'الناس' ]

types = list('kddddkkddkkkdkkkkkkkkdkdkkkkkkkkdkkkkkkkkkkkkkdddkkkkkdkddddddddddkkkkkkkkkdkkkkkkkkkkkkkkkkkkkkkddkkkkkkkkkkdkkkk')

# starting aya of rukus in suar
#_r = [[1],[1,8,21,30,40,47,60,62,72,83,87,97,104,113,122,130,142,148,153,164,168,177,183,189,197,211,217,222,229,232,236,243,249,254,258,261,267,274,282,284],[1,10,21,31,42,55,64,72,81,92,102,110,121,130,144,149,156,172,181,190],[1,11,15,23,26,34,43,51,60,71,77,88,92,97,101,105,113,116,127,135,142,153,163,172],[1,6,12,20,27,35,44,51,57,67,78,87,94,101,109,116],[1,11,21,31,42,51,56,61,71,83,91,95,101,111,122,130,141,145,151,155],[1,11,26,32,40,48,54,59,65,73,85,94,100,109,127,130,142,148,152,158,163,172,182,189],[1,11,20,29,38,45,49,59,65,70],[1,7,17,25,30,38,43,60,67,73,81,90,100,111,119,123],[1,11,21,31,41,54,61,71,83,93,104],[1,9,25,36,50,61,69,84,96,110],[1,7,21,30,36,43,50,58,69,80,94,105],[1,8,19,27,32,38],[1,7,13,22,28,35,42],[1,16,26,45,61,80],[1,10,22,26,35,41,51,61,66,71,77,84,90,101,111,120],[1,11,23,31,41,53,61,71,78,85,94,101],[1,13,18,23,32,45,50,54,60,71,83,102],[1,16,41,51,66,83],[1,25,55,77,90,105,116,129],[1,11,30,42,51,76,94],[1,11,23,26,34,39,49,58,65,73],[1,23,33,51,78,93],[1,11,21,27,35,41,51,58,62],[1,10,21,35,45,61],[1,10,34,53,70,105,123,141,160,176,192],[1,15,32,45,59,67,83],[1,14,22,29,43,51,61,76],[1,14,23,31,45,52,64],[1,11,20,28,41,54],[1,12,20],[1,12,23],[1,9,21,28,35,41,53,59,69],[1,10,22,31,37,46],[1,8,15,27,38],[1,13,33,51,68],[1,22,75,114,139],[1,15,27,41,65],[1,10,22,32,42,53,64,71],[1,10,21,28,38,51,61,69,79],[1,9,19,26,33,45],[1,10,20,30,44],[1,16,26,36,46,57,68],[1,30,43],[1,12,22,27],[1,11,21,27],[1,12,20,29],[1,11,18,27],[1,11],[1,16,30],[1,24,47],[1,29],[1,26,33],[1,23,41],[1,26,46],[1,39,75],[1,11,20,26],[1,7,14],[1,11,18],[1,7],[1,10],[1,9],[1,9],[1,11],[1,8],[1,8],[1,15],[1,34],[1,38],[1,36],[1,21],[1,20],[1,20],[1,32],[1,31],[1,23],[1,41],[1,31],[1,27],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1],[1]];

_r = [
  [1],  # s001
  [1,8,14,17,21,23,26,30,35,40,47,53,57,60,62,67,72,75,80,83,87,91,94,97,101,104,107,110,113,116,119,124,127,130,135,139,142,144,148,153,158,161,164,168,172,174,177,180,183,186,188,190,195,197,203,208,211,214,216,218,222,226,229,232,234,236,238,243,247,249,252,254,258,261,267,271,274,277,281,283,285],  # s002
  [1,5,7,10,14,18,21,26,28,31,33,35,38,42,45,47,51,55,58,64,67,72,76,79,81,83,86,92,96,98,102,104,110,113,116,121,130,137,144,146,149,152,154,156,159,162,165,169,172,176,179,181,185,187,190,194,196],  # s003
  [1,5,10,13,17,22,26,31,34,39,43,47,51,56,60,64,71,75,77,79,82,85,88,92,97,101,105,113,116,123,127,131,135,142,148,153,158,163,167,171,174],  # s004
  [1,3,5,7,10,12,14,17,20,23,27,31,35,40,43,47,51,54,57,61,65,67,70,74,78,82,87,90,94,96,101,105,109,112,116],  # s005
  [1,6,11,14,19,21,27,31,33,36,42,46,51,53,56,59,63,68,71,74,80,83,88,91,93,95,99,102,108,111,114,118,122,125,128,130,136,138,141,143,145,148,151,153,157,159,161],  # s006
  [1,6,11,13,19,22,26,28,32,35,38,40,44,48,52,54,59,65,70,73,75,80,85,88,94,100,103,109,117,127,130,134,138,142,145,148,152,156,158,161,163,166,169,172,175,179,182,186,189,194,199,203],  # s007
  [1,5,9,12,15,18,20,24,26,30,32,36,38,41,43,45,47,49,53,55,59,62,65,67,70,72,74],  # s008
  [1,4,7,12,17,19,23,25,28,30,34,36,38,40,43,49,54,60,64,67,71,73,75,81,86,90,94,97,100,103,107,111,113,117,119,123,128],  # s009
  [1,3,6,11,14,17,21,25,28,31,34,37,41,47,50,54,57,60,62,66,68,71,74,79,83,87,90,93,96,99,104,107],  # s010
  [1,4,6,9,12,15,18,21,25,29,32,36,41,44,47,50,53,58,61,63,66,69,72,77,81,84,87,90,93,96,100,105,110,114,118],  # s011
  [1,4,7,11,16,19,21,23,26,30,32,36,38,41,43,46,50,53,58,63,66,69,73,77,80,83,86,88,91,94,99,101,105,109],  # s012
  [1,3,5,8,12,15,16,17,19,23,27,30,32,35,38,41],  # s013
  [1,4,7,9,11,13,18,21,22,24,28,32,35,38,42,47],  # s014
  [1,6,16,21,26,30,36,45,51,61,72,80,87,94],  # s015
  [5,10,14,18,22,26,30,33,35,37,41,45,51,57,61,63,66,70,74,77,80,84,88,90,93,95,101,106,111,115,120,125],  # s016
  [1,4,7,11,15,18,22,26,31,34,37,40,45,48,53,58,61,66,70,73,78,81,85,89,94,97,101,105],  # s017
  [1,6,9,13,16,18,20,23,27,30,32,37,40,45,47,50,54,57,60,65,71,75,78,83,87,93,99,107],  # s018
  [1,7,12,16,22,27,31,35,41,46,51,58,61,66,73,77,83,88,96],  # s019
  [1,9,17,25,36,42,49,55,60,65,70,72,77,80,83,87,90,95,99,105,110,113,116,123,128,130,133],  # s020
  [1,5,11,16,19,25,30,36,42,45,48,51,56,62,71,74,78,83,87,92,97,101,104,108],  # s021
  [1,4,6,11,15,19,23,26,30,34,36,39,42,47,52,56,60,66,70,73,79],  # s022
  [1,12,17,23,25,31,38,45,51,57,62,68,73,78,84,91,99,105,112],  # s023
  [1,4,11,16,21,23,27,30,32,35,39,41,44,46,51,55,58,60,62],  # s024
  [1,4,7,10,17,21,25,32,35,41,45,51,56,61,67,72],  # s025
  [1,5,10,16,23,34,44,52,61,69,83,91,105,116,123,135,141,154,160,167,176,186,192,200,208,221],  # s026
  [1,7,10,15,18,20,23,27,32,38,41,45,49,54,59,63,67,72,79,83,87,89],  # s027
  [1,7,10,14,18,22,26,29,32,36,39,43,46,48,51,56,58,61,64,68,71,73,76,78,81,83,85],  # s028
  [1,8,10,14,19,24,28,31,36,40,45,48,52,56,61,64],  # s029
  [1,8,11,17,20,24,28,30,33,38,41,46,49,54,58],  # s030
  [1,8,12,14,16,20,22,25,28,31],  # s031
  [1,6,12,15,20,23,26],  # s032
  [1,4,6,9,12,16,18,21,25,28,31,35,37,38,41,49,51,53,54,56,59,63,69],  # s033
  [1,4,7,10,12,15,18,22,25,31,34,38,42,46,51],  # s034
  [1,4,8,10,12,15,19,27,31,36,38,40,42,44],  # s035
  [1,9,13,16,20,27,33,37,41,46,51,55,59,63,68,71,77,81],  # s036
  [1,12,22,33,40,50,62,75,83,91,99,103,114,123,133,139,149,158,167],  # s037
  [1,7,12,17,21,25,27,30,34,41,45,49,59,65,71,79],  # s038
  [1,5,7,10,14,19,22,24,32,36,39,42,47,49,53,56,60,64,70,73],  # s039
  [1,6,10,13,16,20,23,27,30,33,36,38,41,46,51,57,61,66,69,77,79,82],  # s040
  [1,6,9,13,15,19,23,26,29,33,36,39,42,45,49,52],  # s041
  [1,7,10,13,14,17,20,22,24,27,30,36,40,44,47,49,51],  # s042
  [1,9,15,20,24,31,36,40,46,51,57,63,68,74,81,85],  # s043
  [1,9,17,22,30,38,43,51],  # s044
  [1,7,12,16,18,22,24,27,30,33],  # s045
  [1,4,7,9,11,14,16,19,21,24,26,29,33],  # s046
  [1,3,7,12,14,16,20,25,29,35],  # s047
  [1,4,8,11,14,16,18,22,25,27],  # s048
  [1,4,8,11,12,14,16],  # s049
  [1,6,12,16,23,30,36,39],  # s050
  [1,7,15,24,31,38,46,52],  # s051
  [1,11,17,21,29,35,44],  # s052
  [1,10,19,26,30,33,43,50],  # s053
  [1,9,18,23,33,41,47],  # s054
  [1,17,26,33,46,60],  # s055
  [1,10,20,27,41,49,57,68,75,83,88],  # s056
  [1,4,7,9,11,13,16,18,20,22,25,27],  # s057
  [1,3,5,7,8,10,12,14,17,20],  # s058
  [1,3,6,7,9,11,13,15,18,22],  # s059
  [1,3,5,9,11],  # s060
  [1,5,7,10,13],  # s061
  [1,5,9],  # s062
  [1,5,9],  # s063
  [1,5,8,11,14],  # s064
  [1,2,4,6,8,11],  # s065
  [1,3,6,8,10],  # s066
  [1,5,12,18,23,27],  # s067
  [1,8,17,28,34,44],  # s068
  [1,9,19,25,38],  # s069
  [1,11,22,36],  # s070
  [1,5,10,16,21,26],  # s071
  [1,6,11,16,20,25],  # s072
  [1,11,19],  # s073
  [1,11,26,32,49],  # s074
  [1,16,31],  # s075
  [1,7,13,17,23,27],  # s076
  [1,20,29,41],  # s077
  [1,9,17,21,31,38],  # s078
  [1,10,15,20,27,34,40],  # s079
  [1,11,24,33],  # s080
  [1,15],  # s081
  [1,6,13],  # s082
  [1,7,14,22,29],  # s083
  [1,7,16],  # s084
  [1,10],  # s085
  [1],  # s086
  [1,9],  # s087
  [1,8,17],  # s088
  [1,15,21],  # s089
  [1,11],  # s090
  [1,11],  # s091
  [1,12],  # s092
  [1],  # s093
  [1],  # s094
  [1],  # s095
  [1,9],  # s096
  [1],  # s097
  [1,4,6],  # s098
  [1],  # s099
  [1],  # s100
  [1],  # s101
  [1],  # s102
  [1],  # s103
  [1],  # s104
  [1],  # s105
  [1],  # s106
  [1],  # s107
  [1],  # s108
  [1],  # s109
  [1],  # s110
  [1],  # s111
  [1],  # s112
  [1],  # s113
  [1],  # s114
]
# lengths of suar
lengths = [7,286,200,176,120,165,206,75,129,109,123,111,43,52,99,128,111,110,98,135,112,78,118,64,77,227,93,88,69,60,34,30,73,54,45,83,182,88,75,85,54,53,89,59,37,35,38,29,18,45,60,49,62,55,78,96,29,22,24,13,14,11,11,18,12,12,30,52,52,44,28,28,20,56,40,31,50,40,46,42,29,19,36,25,22,17,19,26,30,20,15,21,11,8,8,19,5,8,8,11,11,8,3,9,5,4,7,3,6,3,5,4,5,6]

# indexes of rukus in suar: al-fatiha: [0], al-baqara: [1..40]
rukus_of_sura = []
for s in range(114):
  start = rukus_of_sura[-1][-1] + 1 if rukus_of_sura else 0
  count = len(_r[s])
  rukus_of_sura.append( list(range(start, start + count)) )

# given sura_idx & ifrom (e.g., 1 & 8 for the third ruku in the Quran),
# return ruku_idx_of_sura (e.g., 1, for the third ruku in the Quran; [(0,0), (1,0), (1,1), ...])
def ruku_idx_of_sura(sura_idx, ifrom, *_):
  for ruku_idx, loop_ifrom in enumerate(_r[sura_idx]):
    if loop_ifrom == ifrom:
      return ruku_idx
  # TODO: improve & optimize, or eliminate

# encode and decode {{{1

BAD_CHARS  = '[]/?@'
GOOD_CHARS = '()$!%'

BAD2GOOD = str.maketrans(BAD_CHARS, GOOD_CHARS)
GOOD2BAD = str.maketrans(GOOD_CHARS, BAD_CHARS)

BASE = 85

PAD_CHAR  = "'"
PAD_ORD   = ord(PAD_CHAR)
ZERO_ORD  = 42
ZERO_CHAR = chr(ZERO_ORD)

EF_MIN = 1.3
EF_MAX = 2.5
EF_SCALE = int(BASE**2 / (EF_MAX - EF_MIN))
# to represent EF by exactly 2 chars (no pad; len is known)

def encode_int(n, pad=True, length=0):
  if n != int(n) or n < 0:
    raise ValueError(f"encode_int takes only nonnegative integers; given: `{n}`")
  s = ''
  while n != 0:
    s = chr(n % BASE + ZERO_ORD) + s
    n //= BASE
  # if n == 0 and the loop didn't excute
  if s == '':  s = ZERO_CHAR
  # use fixed length (zeropadded)
  if length:   s = ZERO_CHAR * (length - len(s)) + s
  # padding to encode the length, b/c we don't use delimiters between values
  elif pad:    s = PAD_CHAR * (len(s) - 1) + s
  # sanitize "bad" characters
  s = s.translate(BAD2GOOD)
  return s

def decode_int(s):
  n = 0
  s = s.translate(GOOD2BAD)
  for c in s:
    if c == PAD_CHAR: continue
    n = n * BASE + ord(c) - ZERO_ORD 
  return n

def clamp_ef(ef):
  if ef < EF_MIN: ef = EF_MIN
  if ef > EF_MAX: ef = EF_MAX
  return ef

def fix_ef(ef): return int( (clamp_ef(ef) - EF_MIN) * EF_SCALE)
def defix_ef(ef): return ef / EF_SCALE + EF_MIN

def encode_ef(ef): return encode_int(fix_ef(ef), length=2)
def decode_ef(ef): return defix_ef(decode_int(ef))

# time {{{1

EPOCH = 1625616000

def ts2hr(ts):
  return round((time.mktime(ts) - EPOCH) / 3600)

def hr2ts(hr):
  return time.gmtime(hr * 3600 + EPOCH)  # TODO: or locattime?

def hr_now(): return ts2hr(time.localtime())

# Mem and Card classes {{{1

class Mem:
  #
  def __init__(self, *a, **kw):
    self.set_parameters(*a, **kw)
  #
  def set_parameters(self, repitition=0, efactor=2.5, interval=0, lastreview=None):
    self.__repitition = int(repitition)
    self.__efactor    = clamp_ef(efactor)
    self.__interval   = round(interval)
    self.__lastreview = round(lastreview) if lastreview is not None else None
  #
  @property
  def repitition (self): return self.__repitition
  @property
  def efactor    (self): return self.__efactor
  @property
  def interval   (self): return self.__interval
  @property
  def lastreview (self): return self.__lastreview
  #
  # def __getitem__(self, idx=None):
  #   if idx != int(idx) or idx > 3 or idx:
  #     raise TypeError("indices must be integers")
  #
  def isdue(self, now=hr_now()):
    return self.lastreview is not None and now >= self.lastreview + self.interval
  #
  def serialize_parameters(self, epoch=0):
    if not self.ismemoed():
      return ''
    return (
        encode_int(self.repitition) +
        encode_ef(self.efactor)     +
        encode_int(self.interval)   +
        encode_int(self.lastreview - epoch)
      )
  def jserialize_parameters(self, epoch=0):
    if not self.ismemoed():
      return ''
    return (
        str(self.repitition) + ' ' +
        str(round(self.efactor * 1e5)) + ' ' +
        str(self.interval)   + ' ' +
        str(self.lastreview - epoch) + '\n'
      )
  #
  @efactor.setter
  def efactor(self, efactor):
    self.__efactor = clamp_ef(efactor)
  #
  def ismemoed(self):
    return self.lastreview is not None
  #
  def update_parameters(self, grade):
    if grade < 3:  # if wrong
      self.__repitition = 0
      self.__interval   = 0
    elif not self.ismemoed() or self.repitition == 0:  # if first time
      self.__repitition = 1
      self.__interval   = FIRST_TIME_INTERVAL
    elif self.isdue():  # if reviewing
      self.__repitition += 1
      self.__interval = round(2 * self.interval * self.efactor)
    else:
      # do nothing (just update lastreview; as others)
      pass
    #
    self.__lastreview = hr_now()
    grade_complement = 5 - grade
    self.efactor += 0.1 - grade_complement * (0.08 + grade_complement * 0.02)

class Card(Mem):
  #
  def __init__(self, sura_idx, ifrom, ito, ruku_abs_idx, ruku_sura_idx, *a, **kw):
    super().__init__(*a, **kw)
    self.__sura_idx      = int(sura_idx)
    self.__ifrom         = int(ifrom)
    self.__ito           = int(ito)
    self.__ruku_abs_idx  = int(ruku_abs_idx)
    self.__ruku_sura_idx = int(ruku_sura_idx)
  #
  @property
  def ifrom(self):          return self.__ifrom
  @property
  def ito(self):            return self.__ito
  @property
  def afrom(self):          return arabnum(self.__ifrom)
  @property
  def ato(self):            return arabnum(self.__ito)
  @property
  def sura_idx(self):       return self.__sura_idx
  @property
  def sura_num(self):       return self.__sura_idx + 1
  @property
  def sura_name(self):      return names[self.__sura_idx]
  @property
  def ruku_abs_idx(self):   return self.__ruku_abs_idx
  @property
  def ruku_sura_idx(self):  return self.__ruku_sura_idx
  @property
  def ruku_num(self):       return self.__ruku_sura_idx + 1


# serialize and deserialize {{{1

def serialize(rukuinfo):
  serial = 'ZZX' + encode_int(0)
  try:
    epoch = min(r.lastreview for r in rukuinfo if r.ismemoed())
  except ValueError:  # mostly likely: min() arg is an empty sequence
    return ''
  serial += encode_int(epoch, pad=False) + PAD_CHAR
  #
  for sura_idx in range(114):
    (rr, rukuinfo) = (
        [ r for r in rukuinfo if r.sura_idx == sura_idx ],
        [ r for r in rukuinfo if r.sura_idx != sura_idx ])
    rr = [ r for r in rr if r.ismemoed() ]
    if len(rr) == 0: continue
    serial += encode_int(sura_idx + 1)
    #
    if len(rukus_of_sura[sura_idx]) == 1:
      serial += rr[0].serialize_parameters(epoch)
    else:
      for r in rr:
        ruku_num = encode_int(ruku_idx_of_sura(r.sura_idx, r.ifrom) + 1)
        serial += ruku_num + r.serialize_parameters(epoch)
      serial += ZERO_CHAR
  #
  return serial
w._serialize = serialize

def jserialize(rukuinfo):
  try:
    epoch = min(r.lastreview for r in rukuinfo if r.ismemoed())
  except ValueError:  # mostly likely: min() arg is an empty sequence
    return ''
  serial = 'ZZX0\n'
  serial += f'epoch: {epoch}\n'
  #
  for sura_idx in range(114):
    (rr, rukuinfo) = (
        [ r for r in rukuinfo if r.sura_idx == sura_idx ],
        [ r for r in rukuinfo if r.sura_idx != sura_idx ])
    rr = [ r for r in rr if r.ismemoed() ]
    if len(rr) == 0: continue
    serial += f'sura {sura_idx + 1:03d}\n'
    #
    if len(rukus_of_sura[sura_idx]) == 1:
      serial += '  ' + rr[0].jserialize_parameters(epoch)
    else:
      for r in rr:
        ruku_num = ruku_idx_of_sura(r.sura_idx, r.ifrom) + 1
        serial += f'  {ruku_num:3d}  ' + r.jserialize_parameters(epoch)
  #
  return serial
def jserialize_rukuinfo(): return jserialize(rukuinfo)
w._jserialize_rukuinfo = jserialize_rukuinfo


def deserialize(serial):
  #
  def tokenize():
    nonlocal serial
    i = 0
    for i in range(len(serial)):
      if serial[i] != PAD_CHAR: break
    ii = 2*i+1
    (tok, serial) = serial[:ii], serial[ii:]
    return tok
  #
  def read_int(): return decode_int(tokenize())
  def read_idx(): return decode_int(tokenize()) - 1
  def read_ef():  return decode_ef(tokenize() + tokenize())
  def read_lr():  return decode_int(tokenize()) + epoch
  #
  if serial == '': return
  # print(serial)
  rukuinfo = compute_rukuinfo()
  if serial[:3] != 'ZZX':
    return  # error
  else:
    serial = serial[3:]
  version = read_int()
  (epoch, serial) = serial.split(PAD_CHAR, 1)
  epoch = decode_int(epoch)
  #
  while serial:
    sura_idx = read_idx()
    # print('S:', sura_idx+1)
    if len(rukus_of_sura[sura_idx]) == 1:
      # s = serial; print(names[sura_idx], '-', read_int(), f'{read_ef():g}', read_int(), read_lr() ); serial = s
      rukuinfo[rukus_of_sura[sura_idx][0]].set_parameters(
        read_int(), read_ef(), read_int(), read_lr() )
    else:
      while (ruku_idx := read_idx()) != -1:
        # s = serial; print(names[sura_idx], ruku_idx, read_int(), f'{read_ef():g}', read_int(), read_lr() ); serial = s
        rukuinfo[rukus_of_sura[sura_idx][ruku_idx]].set_parameters(
          read_int(), read_ef(), read_int(), read_lr() )
  #
  return rukuinfo
w.deserialize = deserialize

def jdeserialize(serial):
  lines = serial.split('\n')
  if lines[0] != 'ZZX0':
    return ''
  epoch = lines[1].split()[1]
  #
  rukuinfo = compute_rukuinfo()
  sura_idx = None
  for ln in lines[2:]:
    if ln.startswith('sura '):
      sura_idx = int(ln[5:]) - 1
    elif ln.startswith('  '):
      if len(rukus_of_sura[sura_idx]) == 1:
        params = map(int, ln.split()); params[1] /= 1e5
        rukuinfo[rukus_of_sura[sura_idx][0]].set_parameters(params)
      else:
        (ruku_num, *params) = map(int, ln.split()); params[1] /= 1e5
        # print(params[0], type(params[0]))
        # int(params[0])
        rukuinfo[rukus_of_sura[sura_idx][ruku_num - 1]].set_parameters(*params)
  #
  return rukuinfo
w._jdeserialize = jdeserialize

# rukuinfo: compute_, save_, load_ {{{1

# for each ruku: sura number, in-sura start aya, and in-sura end aya plus one
# making rukus overlap inside suar
# also save SM-2 factors: n (repitition number), ef (EF), hr (hours until next review)
def compute_rukuinfo():
  rukuinfo = []; i = 0
  for s in range(114):
    for k in range(len(_r[s])):
      ifrom       = _r[s][k]
      try:    ito = _r[s][k+1]
      except: ito = lengths[s]
      rukuinfo.append(Card(s, ifrom, ito, i, k)); i += 1
      # n, ef, hr, lr = 0, 2.5, 0, None  # the defaults
      # rukuinfo.append( { 'idx':(s, ifrom, ito), 'n':n, 'ef':ef, 'hr':hr, 'lr':lr } )
  return rukuinfo

def save_rukuinfo(rukuinfo):
  storage['rukuinfo'] = serialize(rukuinfo)
w._save_rukuinfo = save_rukuinfo

def load_rukuinfo():
  try:
    return deserialize(storage['rukuinfo'])
  except KeyError:
    return None
w._load_rukuinfo = load_rukuinfo

def _save(jser):
  r = jdeserialize(jser)
  save_rukuinfo(r)
  global rukuinfo
  rukuinfo = r
  update_cards()
w.save = _save
w.load = jserialize_rukuinfo

rukuinfo = load_rukuinfo() or compute_rukuinfo()

# show_info(), debug related {{{1

def show_info(r=None):
  def _show(r):
    print(
        rukuinfo[r].sura_name,
        rukuinfo[r].ruku_num,
        rukuinfo[r].ifrom,      '---',
        rukuinfo[r].repitition,
        rukuinfo[r].efactor,    '---',
        rukuinfo[r].interval,
        rukuinfo[r].lastreview
    )
  if r is not None:
    _show(r)
  elif LastOne is not None:
    _show(LastOne.ruku_abs_idx)
  elif has_selection():
    for r in range(Selected[0], Selected[1]+1):
      _show(r)


# right-click {{{1

@bind(w, 'contextmenu')
def _contextmenu(ev):
  try:
    r = int(ev.target.dataset['r'])
  except:  # not on a card
    return True  # do nothing; ie, let the menu be invoked
  if not in_multimode():
    init_multiselect(ev)  # ev is ignored
  multiselect(ev)  # looks only at ev.target
  show_info(r)
  ev.preventDefault(); return False  # override the context menu


# warning {{{1

@bind(d['warn_hide_btn'], 'click')
def hide_warning(ev):
  d['warning'].open = False
  d.select('#warning > summary')[0].classList = 'collapsed'
  store_bool('warn', True)

@bind(d['warn_show_btn'], 'click')
def show_warning(ev):
  d['warning'].open = True
  d.select('#warning > summary')[0].classList = ''
  store_bool('warn', False)

@bind(d['warning'], 'toggle')
def __warning_toggle(ev):
  if d['warning'].open:
    show_warning(ev)
  else:
    hide_warning(ev)


# repeat & gonext {{{1


def hide_quick_buttons(): d['repeat_btn'].style.display = d['gonext_btn'].style.display = 'none'
def show_quick_buttons(): d['repeat_btn'].style.display = d['gonext_btn'].style.display = 'inline-block'


# called in update_cards()
# also makes repeat_btn red if a repeat is needed
def show_or_hide_quick_buttons(nowcards_html=None):
  if nowcards_html is None:
    nowcards_html = d['nowcards'].html
  if load_bool('noquick'):
    hide_quick_buttons()
  else:
    need_repeat = None
    if LastOne is not None:
      show_quick_buttons()
      need_repeat = f'data-r="{LastOne.ruku_abs_idx}"' in nowcards_html
    elif d.select('button[class~="lastone"]'):  # multimode
      show_quick_buttons()
      need_repeat = any(
        f'data-r="{r}"' in nowcards_html \
          for r in range(Selected[0], Selected[1]+1)
      )
    d['repeat_btn'].classList = 'repeatlast' if need_repeat else ''


@bind(d['repeat_btn'], 'click')
def __repeat_btn(ev):
  global AllOrNow; AllOrNow = 'all'
  global Selected
  if LastOne is not None:
    recite_card(LastOne)
  else:  # multimode?
    x = d.select('#allcards button[class~="lastone"]')
    if x:
      Selected = [int(c.dataset['r']) for c in x[0], x[-1]]
      __multi_start_btn_click(None)  # arg ignored


@bind(d['gonext_btn'], 'click')
def __gonext_btn(ev):
  global AllOrNow; AllOrNow = 'all'
  last = None
  if LastOne is not None:
    last = LastOne.ruku_abs_idx
  else:  # multimode?
    x = d.select('#allcards button[class~="lastone"]')
    if x:
      last = int(x[-1].dataset['r'])
  if last is not None:
    r = (last + 1) % len(rukuinfo)
    recite_card(rukuinfo[r])


# cards {{{1

AllOrNow = ''  # where the last card is clicked
LastOne = None
Selected = [None, None]

def has_selection(): return Selected[0] is not None and Selected[1] is not None

def in_multimode(): return not d['multimode'].hidden and has_selection()

def nowcards(s):
  now = hr_now()
  return [ r for r in rukus_of_sura[s] if rukuinfo[r].isdue(now) ]


def cards_html(onlynowcards=False):
  if onlynowcards:
    return "".join(fmt_sura(s, nowcards(s)) for s in range(114))
  else:
    return "".join(fmt_sura(s, rukus_of_sura[s]) for s in range(114))


def recite_card(card):
  global LastOne; LastOne = card
  global Selected; Selected = [None, None]
  w.open(f"/recite/{url_for_card(card)}", "recite")  # https://stackoverflow.com/a/30411511


def recite_btn(ev):
  global AllOrNow; AllOrNow = ev.target.parent.parent.parent.id[:3]
  global Selected; Selected = [None, None]
  r = int(ev.target.dataset['r'])
  recite_card(rukuinfo[r])


def update_cards():
  if in_multimode():
    for btn in d.select('button[data-r]'):
      if Selected[0] <= int(btn.dataset['r']) <= Selected[1]:
        btn.class_name += ' selected'
    return  # only update the class of the selected cards
  d['allcards'].html = cards_html(onlynowcards=False)
  #
  nowcards_html = cards_html(onlynowcards=True)
  d['nowcards'].html = nowcards_html
  d['now'].hidden = nowcards_html == ''
  #
  for btn in d.select('button[data-r]'):  # all cards; see fmt_cell()
    btn.bind('click', recite_btn)
  #
  show_or_hide_quick_buttons(nowcards_html)
  #
  # DEBUG:
  # deserialize( serialize( rukuinfo ) )


def url_for_card(card):
  s = card.sura_num
  return f"?{s}/{card.ifrom}-{s}/{card.ito}{otherparams}"


# formatting {{{1

def fmt_cell(r):
  card = rukuinfo[r]
  last = 'lastone' if card is LastOne or has_selection() and Selected[0] <= r <= Selected[1] else ''
  color = f'ef{round(card.efactor * 10)}' if card.ismemoed() else ''
  #
  return f"""<button data-r="{r}" class="{color} {last}"
             title="تسميع سورة {card.sura_name} من الآية {card.afrom} إلى الآية {card.ato}"
             >{card.afrom}</button>"""

def fmt_sura(s, rukus):
  cards = "".join(fmt_cell(r) for r in rukus)
  label = arabnum(s+1) + "&nbsp;" + names[s] + ":"
  cls = types[s]
  cls += ' lastsura' if LastOne is not None and LastOne.sura_idx == s or \
    has_selection() and any(rukuinfo[r].sura_idx == s for r in range(Selected[0], Selected[1]+1)) else ''
  return f'<div><span class="{cls}">{label}</span><span>{cards}</span></div>' if cards else ""

# onload {{{1

def decode_contact():
  mia_nomo = d['abc'].href[19:28]
  d['xyz'].html = mia_nomo + chr(1<<6) + 'pro' + chr(ord(str(0B100))|0O100) + 'moc.liamno'[::-1]
  d['xyz'].href = d['xyz'].html[16:20] + 'to' + chr(ord('xyz'[1<<1])^0O100) + d['xyz'].html
  # if you know a better way, please let me know!

def onload():
  update_prefs()
  update_otherparams()  # reloading keeps the checkboxes' values
  decode_contact()
  update_cards()
  set_interval(update_cards, 5*60*1000)  # every 5 minutes
  # TODO: check requestAnimationFrame()

onload()

# grading {{{1

def show_pop(_=0):
  d['pop'].hidden = False
  d['pop'].style.opacity = 100
  d.body.class_name = 'scrolllock'

def hide_pop(_=0):
  update_cards()
  d.body.class_name = ''
  d['pop'].style.opacity = 0
  def _real_hide():
    d['pop'].hidden = True
  set_timeout(_real_hide, 500)
  show_info()
  _hide_recite_end()

def set_ef(r, q):
  rukuinfo[r].update_parameters(q)
  save_rukuinfo(rukuinfo)
  hide_pop()

def set_efs(r_from, r_to, q):
  for r in range(r_from, r_to+1):
    rukuinfo[r].update_parameters(q)
  save_rukuinfo(rukuinfo)
  hide_pop()

def grade(q):
  if LastOne:  # single mode
    set_ef(LastOne.ruku_abs_idx, q)
  else:  # multi mode
    set_efs(*Selected, q)

@bind(d.body, 'keyup')
def __kb(ev):
  if d['repeat_btn'].style.display == 'inline-block' and ev.key in ('7', '٧'): return d['repeat_btn'].click()
  if d['gonext_btn'].style.display == 'inline-block' and ev.key in ('8', '٨'): return d['gonext_btn'].click()
  if d['pop'].hidden:
    return  # only handle keyups on #pop
  if ev.shiftKey or ev.ctrlKey or ev.altKey:
    return  # Ignore if a modifier is used (e.g., Ctrl+0 is Reset Zoom)
  elif ev.key in ('0', '٠', 'Escape'):  hide_pop()
  elif ev.key in ('1', '١'):  grade(5)
  elif ev.key in ('2', '٢'):  grade(4)
  elif ev.key in ('3', '٣'):  grade(3)
  elif ev.key in ('4', '٤'):  grade(2)
  elif ev.key in ('5', '٥'):  grade(1)
  # else: do nothing

d['dismiss'].bind('click', hide_pop)

for i in range(6):
  d[f'q{i}'].bind('click', lambda e, i=i: grade(i))

# import and export buttons {{{1

@bind(d['export'], 'click')
def export(ev=0):  # https://stackoverflow.com/q/3665115
  filename = time.strftime('Export-%Y-%m-%d-%H%M.ZZX')
  # blob = w.Blob.new(serialize(rukuinfo), {'type':)
  # a = t.A(href=w.URL.createObjectURL(serialize(rukuinfo)), download='export.zz')
  a = t.A(href='data:application/octet-stream,' + serialize(rukuinfo),
      download=filename, style={'display': 'none'})
  d.body.appendChild(a)
  a.click()
  d.body.removeChild(a)

@bind(d['import'], 'click')
def import_(ev):
  file = t.INPUT(Id='infile', Type='file')
  # https://www.geeksforgeeks.org/how-to-read-a-local-text-file-using-javascript/
  @bind(file, 'change')
  def read(ev):
    reader = w.FileReader.new()
    @bind(reader, 'load')
    def red(e):
      global rukuinfo
      rukuinfo = deserialize(reader.result)
      update_cards()
      save_rukuinfo(rukuinfo)
    reader.readAsText(file.files[0])
  file.click()

# prefs buttons {{{1

@bind(d['imla_btn'], 'click')
def __imla_btn_click(ev):
  d['imla_chk'].checked ^= 1  # toggle
  store_bool('imla', d['imla_chk'].checked)
  update_otherparams()

@bind(d['dark_btn'], 'click')
def __dark_btn_click(ev):
  d['dark_chk'].checked ^= 1  # toggle
  storage['dark'] = 'Y' if d['dark_chk'].checked else 'N'
  update_otherparams()

@bind(d['taj_btn'], 'click')
def __taj_btn_click(ev):
  d['taj_chk'].checked ^= 1  # toggle
  store_bool('notajweed', not d['taj_chk'].checked)
  update_otherparams()

@bind(d['quick_btn'], 'click')
def __quick_btn_click(ev):
  if d['quick_chk'].checked:
    d['quick_chk'].checked = False
    store_bool('noquick', True)
    hide_quick_buttons()
  else:
    d['quick_chk'].checked = True
    store_bool('noquick', False)
    show_or_hide_quick_buttons()

@bind('#mvbtns > button', 'click')
def __mvbtns_btn_click(ev):
  if   ev.target.id == 'mvbtns_b': old = 'b'; new = 'r'
  elif ev.target.id == 'mvbtns_r': old = 'r'; new = 'l'
  elif ev.target.id == 'mvbtns_l': old = 'l'; new = 'b'
  d['mvbtns_' + old].style.display = 'none'
  d['mvbtns_' + new].style.display = 'inline-block'
  if new == 'b':
    if 'mvbtns' in storage:
      del storage['mvbtns']
  else:
      storage['mvbtns'] = new
  update_otherparams()

@bind('#fbrate > button', 'click')
def __fbrate_btn_click(ev):
  if   ev.target.id == 'fbrate_l': old = 'l'; new = 'w'
  elif ev.target.id == 'fbrate_w': old = 'w'; new = 'a'
  elif ev.target.id == 'fbrate_a': old = 'a'; new = 'l'
  d['fbrate_' + old].style.display = 'none'
  d['fbrate_' + new].style.display = 'inline-block'
  if new == 'l':
    if 'fbrate' in storage:
      del storage['fbrate']
  else:
      storage['fbrate'] = new
  update_otherparams()

# multi mode buttons {{{1

def multiselect(ev):
  global Selected
  b = ev.target
  r = int(b.dataset['r'])
  if Selected[0] is None or r < Selected[0]: Selected[0] = r
  if Selected[1] is None or r > Selected[1]: Selected[1] = r
  update_cards()

@bind(d['multi'], 'click')
def init_multiselect(ev):
  global Selected
  global LastOne
  d['altmode'].hidden = True
  d['multimode'].hidden = False
  LastOne = None
  Selected = [None, None]
  for btn in d.select('button[data-r]'):  # all cards; see fmt_cell()
    btn.unbind('click')
    btn.bind('click', multiselect)

@bind(d['multi-start'], 'click')
def __multi_start_btn_click(ev):
  d['altmode'].hidden = False
  d['multimode'].hidden = True
  card_from, card_to = rukuinfo[Selected[0]], rukuinfo[Selected[1]]
  sura_from, sura_to = card_from.sura_num, card_to.sura_num
  aaya_from, aaya_to = card_from.ifrom, card_to.ito
  w.open(f'/recite/?{sura_from}/{aaya_from}-{sura_to}/{aaya_to}{otherparams}', 'recite')
  d.body.class_name = 'scrolllock'
  update_cards()  # restore their normal behavior

@bind(d['multi-cancel'], 'click')
def __multi_cancel_btn_click(ev):
  global Selected
  d['altmode'].hidden = False
  d['multimode'].hidden = True
  Selected = [None, None]
  update_cards()  # restore their normal behavior

# recite integration functions {{{1

def set_title(title='ذكر الذكر - مراجعة حفظ القرءان الكريم'):  # the same in the html page
  d.select('title')[0].html = title

def _hide_recite_begin():
  d['recite'].hidden = True
  d['recite'].src = 'about:blank'
  set_title()  # reset to the default

def _hide_recite_end():
  d.body.class_name = ''
  # then focus the just-recited card
  if LastOne is None:  # multi-mode
    return  # no idea what should I do then
  last = d.select(f'#{AllOrNow}cards button[data-r="{LastOne.ruku_abs_idx}"]')
  if last:
    last[0].focus()
  else:  # happens when a now-card is removed from #nowcards.
    pass  # I do not know what should I do then.

def zz_ignore():
  _hide_recite_begin()
  update_cards()
  _hide_recite_end()
w.zz_ignore = zz_ignore

def zz_done():
  _hide_recite_begin()
  show_pop()
w.zz_done = zz_done

def zz_show():
  d.body.class_name = 'scrolllock'
  d['recite'].hidden = False
  d['recite'].focus()
w.zz_show = zz_show

def zz_set_quizmode(v):
  imla = v == 'imla'
  d['imla_chk'].checked = imla
  store_bool('imla', imla)
  update_otherparams()
w.zz_set_quizmode = zz_set_quizmode

def zz_set_tajweed(v):
  taj = v == 't' # parts ('b') is considered notajweed
  d['taj_chk'].checked = taj
  store_bool('notajweed', not taj)
  update_otherparams()
w.zz_set_tajweed = zz_set_tajweed

def zz_set_dark(dark):
  d['dark_chk'].checked = dark
  storage['dark'] = 'Y' if dark else 'N'
  update_otherparams()
w.zz_set_dark = zz_set_dark

def zz_set_mvbtns(v):
  d['mvbtns_b'].style.display = 'none'
  d['mvbtns_r'].style.display = 'none'
  d['mvbtns_l'].style.display = 'none'
  d['mvbtns_' + v].style.display = 'block'
  if v == 'b':
    if 'mvbtns' in storage:
      del storage['mvbtns']
  else:
      storage['mvbtns'] = v
  update_otherparams()
w.zz_set_mvbtns = zz_set_mvbtns

def zz_set_feedbackrate(v):
  d['fbrate_l'].style.display = 'none'
  d['fbrate_w'].style.display = 'none'
  d['fbrate_a'].style.display = 'none'
  d['fbrate_' + v].style.display = 'block'
  if v == 'l':
    if 'fbrate' in storage:
      del storage['fbrate']
  else:
      storage['fbrate'] = v
  update_otherparams()
w.zz_set_feedbackrate = zz_set_feedbackrate

def zz_set_title(title):
  set_title(title + ' | ذكر الذكر')
  # set msg
  msg = title[6:]  # remove 'تسميع '
  if msg.startswith('ال'):
    d['msg'].html = f'كيف حال حفظك ل{msg[1:]}؟'
  elif msg.startswith('سور'):  # سورة or سورتي
    d['msg'].html = f'كيف حال حفظك ل{msg}؟'
  else:  # msg.startswith('من '):
    d['msg'].html = f'كيف حال حفظك للآيات {msg}؟'
w.zz_set_title = zz_set_title

# vim: set foldmethod=marker foldmarker={{{,}}} :