o +ke4@sddlZddlZddlZddlZddlmZmZddlmZddl m Z ddl m Z m Z m Z ddlmZddlmZdd lmZmZeeZd ZGd d d eZGd ddeZGdddeZGdddeZdS)N) KeyfileKeyKeyfileNotFoundError)REPOSITORY_README)ProgressIndicatorPercent) get_base_dir get_keys_dir get_cache_dir)Lock) create_logger) RepositoryMAGICsATTICSEGcsneZdZfddZdddZddZedd d Zedd d Zd dZ eddZ ddZ ddZ Z S)AtticRepositoryUpgradercs&d|d<d|d<tj|i|dS)NFlockZcheck_segment_magic)super__init__)selfargskw __class__1usr/lib/python3.10/site-packages/borg/upgrader.pyrsz AtticRepositoryUpgrader.__init__TFc CsV|dd}|s%|jdtjd}td||s%tj|j|tjdtdt tj |jddd d  |_ d d |j D}z|}WntyXtd Ynw|||Wdn1siwYt tj |jddd |_ z$|||j||d|j||||d|W|j d|_ |S|j d|_ w)aconvert an attic repository to a borg repository those are the files that need to be upgraded here, from most important to least important: segments, key files, and various caches, the latter being optional, as they will be rebuilt if missing. we nevertheless do the order in reverse, as we prefer to do the fast stuff first, to improve interactivity. Nz.before-upgrade-z%Y-%m-%d-%H:%M:%Szmaking a hardlink copy in %s) copy_functionz1opening attic repository with borg and convertingrTg?) exclusivetimeoutcSsg|]\}}|qSrr).0ifilenamerrr .sz3AtticRepositoryUpgrader.upgrade.. no key file found for repository)r)dryruninplace)r!r"progress)pathdatetimenowloggerinfoshutilcopytreeoslinkr joinacquirerioZsegment_iteratorfind_attic_keyfilerwarningconvert_keyfiles convert_cacheconvert_repo_indexconvert_segments borg_readmerelease)rr!r"r#Zbackupsegmentskeyfilerrrupgrades:           zAtticRepositoryUpgrader.upgradecCsTtj|jd}t|t|d}|tWddS1s#wYdS)NREADMEw)r+r$r-removeopenwriter)rreadmefdrrrr6As    "z#AtticRepositoryUpgrader.borg_readmecCs~tdt|t|}t|ddd}t|D]\}}|r#|||r+tdqtj |t t |dq|r=| dSdS)aconvert repository segments from attic to borg replacement pattern is `s/ATTICSEG/BORG_SEG/` in files in `$ATTIC_REPO/data/**`. luckily the magic string length didn't change so we can just replace the 8 first bytes of all regular files in there.zconverting %d segments...zConverting segments %3.0f%%zupgrade.convert_segments)totalmsgmsgidgMbP?r"N) r'r(lenr enumerateZshowtimesleeprheader_replace ATTIC_MAGICr Zfinish)r8r!r"r#Z segment_countpirrrrrr5Gs    z(AtticRepositoryUpgrader.convert_segmentsc Cst|dd}|d|t||krY|r!|d||n@t||dt|d}||||Wdn1sEwYt|dWddSWddSWddS1slwYdS)Nzr+brz.tmpwb)r>seekreadrFr?r+renameunlink)rZ old_magicZ new_magicr"segmentZ new_segmentrrrrJ]s"      "z&AtticRepositoryUpgrader.header_replacecC t|S)aefind the attic keyfiles the keyfiles are loaded by `KeyfileKey.find_key_file()`. that finds the keys with the right identifier for the repo. this is expected to look into $HOME/.attic/keys or $ATTIC_KEYS_DIR for key files matching the given Borg repository. it is expected to raise an exception (KeyfileNotFoundError) if no key is found. whether that exception is from Borg or Attic is unclear. this is split in a separate function in case we want to use the attic code here directly, instead of our local implementation.)AtticKeyfileKey find_key_filerrrrr0rs z*AtticRepositoryUpgrader.find_attic_keyfilecCstd|t| }|}Wdn1swY|tjtjd}tj t tj |}td||sZt|d}| |WddS1sSwYdSdS)aconvert key files from attic to borg replacement pattern is `s/ATTIC KEY/BORG_KEY/` in `get_keys_dir()`, that is `$ATTIC_KEYS_DIR` or `$HOME/.attic/keys`, and moved to `$BORG_KEYS_DIR` or `$HOME/.config/borg/keys`. no need to decrypt to convert. we need to rewrite the whole key file because magic string length changed, but that's not a problem because the keyfiles are small (compared to, say, all the segments).zconverting keyfile %sNrzwriting borg keyfile to %sr<)r'r(r>rOreplacerTFILE_IDrr+r$r-rbasenamer?)r9r!fdatarrrr2s    "z(AtticRepositoryUpgrader.convert_keyfilescCsd|}|durtd|jdStj|jd|}td||s0tj|dd|ddSdS)aconvert some repo files those are all hash indexes, so we need to `s/ATTICIDX/BORG_IDX/` in a few locations: * the repository index (in `$ATTIC_REPO/index.%d`, where `%d` is the `Repository.get_index_transaction_id()`), which we should probably update, with a lock, see `Repository.open()`, which i'm not sure we should use because it may write data on `Repository.close()`... Nz%no index file found for repository %szindex.%dzconverting repo index %sATTICIDXBORG_IDXrE) Zget_index_transaction_idr'r1r$r+r-r(rrJ)rr!r"Ztransaction_idindexrrrr4s z*AtticRepositoryUpgrader.convert_repo_indexcstjdtjtddtj|jtjt|jfdd}tjrZtjs8t dD]}||q:dD]}||}t d|sYt |d d qCd Sd S) aconvert caches from attic to borg those are all hash indexes, so we need to `s/ATTICIDX/BORG_IDX/` in a few locations: * the `files` and `chunks` cache (in `$ATTIC_CACHE_DIR` or `$HOME/.cache/attic//`), which we could just drop, but if we'd want to convert, we could open it with the `Cache.open()`, edit in place and then `Cache.close()` to make sure we have locking right ZATTIC_CACHE_DIRz.cacheZatticcstj|}tj|r7tj|}tj|r"td||Std|d|s5t|||Std|d|dS)acopy the given attic cache path into the borg directory does nothing if dryrun is True. also expects attic_cache_dir and borg_cache_dir to be set in the parent scope, to the directories path including the repository identifier. :params path: the basename of the cache file to copy (example: "files" or "chunks") as a string :returns: the borg file that was created or None if no Attic cache file was found. zAtticRepositoryUpgrader.convert_cache..copy_cache_file)configfiles)chunkszconverting cache %sr\r]N)r+environgetr$r-rid_strr r_makedirsr'r(rrJ)rr!rbcacherrarr3s*      z%AtticRepositoryUpgrader.convert_cacheTFF)T)__name__ __module__ __qualname__rr:r6 staticmethodr5rJr0r2r4r3 __classcell__rrrrrs  (   rc@s,eZdZdZdZeddZeddZdS)rTz*backwards compatible Attic key file parserz ATTIC KEYcCtjdtjtddS)z,Determine where to repository keys and cacheZATTIC_KEYS_DIRz.attickeysr+rfrgr$r-rrrrrrszAtticKeyfileKey.get_keys_dirc Cs|j}|}tj|st|j|t|D]?}tj||}t|*}| }|rG| |j rG|dd|j krG|WdSWdn1sQwYqt|j|)awcopy of attic's `find_key_file`_ this has two small modifications: 1. it uses the above `get_keys_dir`_ instead of the global one, assumed to be borg's 2. it uses `repository.path`_ instead of `repository._location.canonical_path`_ because we can't assume the repository has been opened by the archiver yet N) rr+r$r_rlistdirr-r>readlinestrip startswithrXrhcls repositoryrZkeys_dirnamerrAlinerrrrUs     " zAtticKeyfileKey.find_key_fileN) rlrmrn__doc__rXror classmethodrUrrrrrTs rTc@s&eZdZd ddZddZddZd S) BorgRepositoryUpgraderTFc Csztd|,z|}WntytdYnw|||WddSWddS1s6wYdS)zDconvert an old borg repository to a current borg repository z$converting borg 0.xx to borg currentr N)r'r(find_borg0xx_keyfilerr1 move_keyfiles)rr!r"r#r9rrrr:s   "zBorgRepositoryUpgrader.upgradecCrSN)Borg0xxKeyfileKeyrUrVrrrr%s z+BorgRepositoryUpgrader.find_borg0xx_keyfilecCsDtj|}tjt|}z t||WdSty!YdSwr)r+r$rYr-rrPFileExistsError)rr9r!rZ new_keyfilerrrr(s  z$BorgRepositoryUpgrader.move_keyfilesNrk)rlrmrnr:rrrrrrrs  rc@s(eZdZdZeddZeddZdS)rz.backwards compatible borg 0.xx key file parsercCrq)NZ BORG_KEYS_DIRz.borgrrrsrrrrr5szBorg0xxKeyfileKey.get_keys_dirc Cs|j}|}tj|st|j|t|D]D}tj||}t|/}| }|rL| |j rL|t |j dd|j krL|WdSWdn1sVwYqt|j|)Nr)rr+r$r_rrur-r>rvrwrxrXrFrhryrrrrU:s    , zBorg0xxKeyfileKey.find_key_fileN)rlrmrnr~rorrrUrrrrr2s  r)r%r+r)rHZ crypto.keyrr constantsrhelpersrrrr Zlockingr r'r r{r r rlrKrrTrrrrrrs$    a%