Anki/anki/importing/anki2.py
2011-11-25 14:13:14 +09:00

247 lines
8.5 KiB
Python

# -*- coding: utf-8 -*-
# Copyright: Damien Elmes <anki@ichi2.net>
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
from anki import Collection
from anki.utils import intTime
from anki.importing.base import Importer
from anki.lang import _
#
# Import a .anki2 file into the current collection. Used for migration from
# 1.x, shared decks, and import from a packaged deck.
#
# We can't rely on internal ids, so we:
# - compare notes by guid
# - compare models by schema signature
# - compare cards by note guid + ordinal
# - compare decks by name
#
class Anki2Importer(Importer):
needMapper = False
deckPrefix = None
needCards = True
def run(self, media=None):
self._prepareFiles()
if media is not None:
# Anki1 importer has provided us with a custom media folder
self.src.media._dir = media
try:
self._import()
finally:
self.src.close(save=False)
def _prepareFiles(self):
self.dst = self.col
self.src = Collection(self.file, queue=False)
def _import(self):
self._decks = {}
if self.deckPrefix:
id = self.dst.decks.id(self.deckPrefix)
self.dst.decks.select(id)
self._prepareTS()
self._prepareModels()
self._importNotes()
self._importCards()
self._importMedia()
self._postImport()
self.dst.db.execute("vacuum")
self.dst.db.execute("analyze")
# Notes
######################################################################
# - should note new for wizard
def _importNotes(self):
# build guid -> (id,mod,mid) hash
self._notes = {}
for id, guid, mod, mid in self.dst.db.execute(
"select id, guid, mod, mid from notes"):
self._notes[guid] = (id, mod, mid)
# iterate over source collection
add = []
dirty = []
for note in self.src.db.execute(
"select * from notes"):
# turn the db result into a mutable list
note = list(note)
guid, mid = note[1:3]
# missing from local col?
if guid not in self._notes:
# get corresponding local model
lmid = self._mid(mid)
# rewrite internal ids, models, etc
note[0] = self.ts()
note[2] = lmid
note[3] = self._did(note[3])
note[4] = intTime()
note[5] = -1 # usn
add.append(note)
dirty.append(note[0])
# note we have the added note
self._notes[guid] = (note[0], note[4], note[2])
else:
continue #raise Exception("merging notes nyi")
# add to col
self.dst.db.executemany(
"insert or replace into notes values (?,?,?,?,?,?,?,?,?,?,?,?)",
add)
self.dst.updateFieldCache(dirty)
self.dst.tags.registerNotes(dirty)
# Models
######################################################################
def _prepareModels(self):
"Prepare index of schema hashes."
self._modelMap = {}
def _mid(self, mid):
"Return local id for remote MID."
# already processed this mid?
if mid in self._modelMap:
return self._modelMap[mid]
src = self.src.models.get(mid).copy()
if not self.needCards:
src['needWizard'] = 1
# if it doesn't exist, we'll copy it over, preserving id
if not self.dst.models.have(mid):
self.dst.models.update(src)
# make sure to bump usn
self.dst.models.save(src)
self._modelMap[mid] = mid
return mid
# if it does exist, do the schema match?
dst = self.dst.models.get(mid)
dhash = self.src.models.scmhash(dst)
if self.src.models.scmhash(src) == dhash:
# reuse without modification
self._modelMap[mid] = mid
return mid
# try any alternative versions
vers = src.get("vers")
for v in vers:
m = self.src.models.get(v)
if self.src.models.scmhash(m) == dhash:
# valid alternate found; use that
self._modelMap[mid] = m['id']
return m['id']
# need to add a new alternate version, with new id
self.dst.models._add(src)
if vers:
dst['vers'].append(src['id'])
else:
dst['vers'] = [src['id']]
# Decks
######################################################################
def _did(self, did):
"Given did in src col, return local id."
# already converted?
if did in self._decks:
return self._decks[did]
# get the name in src
g = self.src.decks.get(did)
name = g['name']
# if there's a prefix, replace the top level deck
if self.deckPrefix:
tmpname = "::".join(name.split("::")[1:])
name = self.deckPrefix
if tmpname:
name += "::" + name
# create in local
newid = self.dst.decks.id(name)
# add to deck map and return
self._decks[did] = newid
return newid
# Cards
######################################################################
def _importCards(self):
if not self.needCards:
return
# build map of (guid, ord) -> cid
self._cards = {}
for guid, ord, cid in self.dst.db.execute(
"select f.guid, c.ord, c.id from cards c, notes f "
"where c.nid = f.id"):
self._cards[(guid, ord)] = cid
# loop through src
cards = []
revlog = []
print "fixme: need to check schema issues in card import"
cnt = 0
for card in self.src.db.execute(
"select f.guid, f.mid, c.* from cards c, notes f "
"where c.nid = f.id"):
guid = card[0]
# does the card's note exist in dst col?
if guid not in self._notes:
continue
dnid = self._notes[guid]
# does the note share the same schema?
# shash = self._srcModels[card[1]]
# mid = self._notes[guid][2]
# if shash != self._dstModels[mid]:
# continue
# does the card already exist in the dst col?
ord = card[5]
if (guid, ord) in self._cards:
# fixme: in future, could update if newer mod time
continue
# doesn't exist. strip off note info, and save src id for later
card = list(card[2:])
scid = card[0]
# update cid, nid, etc
card[0] = self.ts()
card[1] = self._notes[guid][0]
card[2] = self._did(card[2])
card[4] = intTime()
cards.append(card)
# we need to import revlog, rewriting card ids
for rev in self.src.db.execute(
"select * from revlog where cid = ?", scid):
rev = list(rev)
rev[1] = card[0]
revlog.append(rev)
cnt += 1
# apply
self.dst.db.executemany("""
insert into cards values (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)""", cards)
self.dst.db.executemany("""
insert into revlog values (?,?,?,?,?,?,?,?,?)""", revlog)
self.log.append(_("%d cards imported.") % cnt)
# Media
######################################################################
def _importMedia(self):
self.log.append(
_("%d media imported.") %
self.src.media.copyTo(self.dst.media.dir()))
# Post-import cleanup
######################################################################
# fixme: we could be handling new card order more elegantly on import
def _postImport(self):
if self.needCards:
# make sure new position is correct
self.dst.conf['nextPos'] = self.dst.db.scalar(
"select max(due)+1 from cards where type = 0")
else:
# newly added models will have been flagged with needWizard=1; we
# need to mark reused models with needWizard=2 so the new cards
# can be generated
for mid in self._modelMap.values():
m = self.dst.models.get(mid)
if not m.get("needWizard"):
m['needWizard'] = 2
self.dst.models.save(m)
self.dst.save()