sjs/vdirsyncer
1
0
Fork 0
mirror of https://github.com/samsonjs/vdirsyncer.git synced 2026-04-27 14:57:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Dont repair unsafe UIDs by default, fix #527

Browse source
This commit is contained in:
Markus Unterwaditzer 2016-12-06 15:58:16 +01:00
parent eadb7203ee
commit 96bf21c1da
5 changed files with 27 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CHANGELOG.rst
View file

@ -9,6 +9,12 @@ Package maintainers and users who have to manually update their installation
may want to subscribe to `GitHub's tag feed may want to subscribe to `GitHub's tag feed
<https://github.com/pimutils/vdirsyncer/tags.atom>`_. <https://github.com/pimutils/vdirsyncer/tags.atom>`_.
Version 0.13.1
==============
- ``vdirsyncer repair`` no longer changes "unsafe" UIDs by default, an extra
option has to be specified. See :gh:`527`.
Version 0.14.0 Version 0.14.0
============== ==============

4
tests/test_repair.py
View file

@ -28,7 +28,7 @@ def test_repair_uids(uid):
uid1, uid2 = [s.get(href)[0].uid for href, etag in s.list()] uid1, uid2 = [s.get(href)[0].uid for href, etag in s.list()]
assert uid1 == uid2 assert uid1 == uid2
repair_storage(s) repair_storage(s, repair_unsafe_uid=False)
uid1, uid2 = [s.get(href)[0].uid for href, etag in s.list()] uid1, uid2 = [s.get(href)[0].uid for href, etag in s.list()]
assert uid1 != uid2 assert uid1 != uid2
@ -44,7 +44,7 @@ def test_repair_unsafe_uids(uid):
assert s.get(href)[0].uid == uid assert s.get(href)[0].uid == uid
assert not href_safe(uid) assert not href_safe(uid)
repair_storage(s) repair_storage(s, repair_unsafe_uid=True)
new_href = list(s.list())[0][0] new_href = list(s.list())[0][0]
assert href_safe(new_href) assert href_safe(new_href)

15
vdirsyncer/cli/__init__.py
View file

@ -207,16 +207,20 @@ def discover(ctx, pairs, max_workers, list):
@app.command() @app.command()
@click.argument('collection') @click.argument('collection')
@click.option('--repair-unsafe-uid/--no-repair-unsafe-uid', default=False,
help=('Some characters in item UIDs and URLs may cause problems '
'with buggy software. Adding this option will reassign '
'new UIDs to those items.'))
@pass_context @pass_context
@catch_errors @catch_errors
def repair(ctx, collection): def repair(ctx, collection, repair_unsafe_uid):
''' '''
Repair a given collection. Repair a given collection.
Runs a few checks on the collection and applies some fixes to individual Runs a few checks on the collection and applies some fixes to individual
items that may improve general stability, also with other CalDAV/CardDAV items that may improve general stability, also with other CalDAV/CardDAV
clients. In particular, if you encounter URL-encoding-related issues with clients. In particular, if you encounter URL-encoding-related issues with
other clients, this command might help. other clients, this command with --repair-unsafe-uid might help.
Example: `vdirsyncer repair calendars_local/foo` repairs the `foo` Example: `vdirsyncer repair calendars_local/foo` repairs the `foo`
collection of the `calendars_local` storage. collection of the `calendars_local` storage.
@ -224,7 +228,8 @@ def repair(ctx, collection):
from .tasks import repair_collection from .tasks import repair_collection
cli_logger.warning('This operation will take a very long time.') cli_logger.warning('This operation will take a very long time.')
cli_logger.warning('It\'s recommended to turn off other client\'s ' cli_logger.warning('It\'s recommended to make a backup and '
'synchronization features.') 'turn off other client\'s synchronization features.')
click.confirm('Do you want to continue?', abort=True) click.confirm('Do you want to continue?', abort=True)
repair_collection(ctx.config, collection) repair_collection(ctx.config, collection,
repair_unsafe_uid=repair_unsafe_uid)

4
vdirsyncer/cli/tasks.py
View file

@ -93,7 +93,7 @@ def discover_collections(wq, pair, **kwargs):
.format(pair.name, json.dumps(collections))) .format(pair.name, json.dumps(collections)))
def repair_collection(config, collection): def repair_collection(config, collection, repair_unsafe_uid):
from ..repair import repair_storage from ..repair import repair_storage
storage_name, collection = collection, None storage_name, collection = collection, None
@ -120,7 +120,7 @@ def repair_collection(config, collection):
cli_logger.info('Repairing {}/{}'.format(storage_name, collection)) cli_logger.info('Repairing {}/{}'.format(storage_name, collection))
cli_logger.warning('Make sure no other program is talking to the server.') cli_logger.warning('Make sure no other program is talking to the server.')
repair_storage(storage) repair_storage(storage, repair_unsafe_uid=repair_unsafe_uid)
def metasync_collection(wq, collection, general): def metasync_collection(wq, collection, general):

6
vdirsyncer/repair.py
View file

@ -8,7 +8,7 @@ from .utils import generate_href, href_safe
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
def repair_storage(storage): def repair_storage(storage, repair_unsafe_uid):
seen_uids = set() seen_uids = set()
all_hrefs = list(storage.list()) all_hrefs = list(storage.list())
for i, (href, _) in enumerate(all_hrefs): for i, (href, _) in enumerate(all_hrefs):
@ -30,6 +30,10 @@ def repair_storage(storage):
logger.warning('Duplicate UID, assigning random one.') logger.warning('Duplicate UID, assigning random one.')
new_item = item.with_uid(generate_href()) new_item = item.with_uid(generate_href())
elif not href_safe(item.uid) or not href_safe(basename(href)): elif not href_safe(item.uid) or not href_safe(basename(href)):
if not repair_unsafe_uid:
logger.warning('UID or href may cause problems, add '
'--repair-unsafe-hrefs to repair.')
else:
logger.warning('UID or href is unsafe, assigning random UID.') logger.warning('UID or href is unsafe, assigning random UID.')
new_item = item.with_uid(generate_href(item.uid)) new_item = item.with_uid(generate_href(item.uid))