kriegaex / Galileo-Openbook-Cleaner

HTML cleaner for Galileo Computing's openbooks, implemented in Java
Other
64 stars 6 forks source link

Make MD5 mismatch error message more user-friendly #25

Closed kriegaex closed 8 years ago

kriegaex commented 10 years ago

As a user, I want to understand what an MD5 mismatch during openbook download means so that I know what to do next.

Acceptance criteria:

Related tickets: #4, #13, #14, #24

kriegaex commented 8 years ago

Aktuelle Entwicklerversion (Snapshot) mit ausführlicherer Fehlermeldung kann heruntergeladen werden unter http://scrum-master.de/download/GalileoOpenbookCleaner/openbook_cleaner-1.2.0-SNAPSHOT.jar.

Fehlermeldung sieht nun so aus:

Possible download problem detected: MD5 checksum mismatch.
  Book title:    Java 7 - mehr als eine Insel
  Download file: ..\openbooks\galileocomputing_javainsel.zip
  MD5 expected:  fffffa7cba1f2f9573663f37f711c9c
  MD5 actual:    6f6aea7cba1f2f9573663f37f711c9c

Possible reasons are:
  - corrupt download file due to incomplete download process
  - download file was updated on server

The program will try to unpack and clean the download archive anyway.

In case of problems you have the following options:
  - If you think the download file is corrupt, just delete it and restart the
    program so as to get a fresh download.
  - If you think that the download file is okay but the cleanup does not work
    correctly, please notify the program author by creating a ticket at
    https://github.com/kriegaex/Galileo-Openbook-Cleaner/issues, but only if
    an equivalent ticket does not already exist.
  - If the cleanup works correctly even despite the MD5 mismatch, please also
    notify the author as explained above. Meanwhile you can avoid this error
    message by using the --write-config option first and afterwards update the
    MD5 checksum for the corresponding openbook manually in config.xml.