Review Request 118686: libkdeedu / parley : fix Bug 240552 - Second parley process cancels out changes in language file when closing

[Andreas Xavier]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/118686/
-----------------------------------------------------------

(Updated June 23, 2014, 6:19 a.m.)


Review request for KDE Edu.


Changes
-------

Adds lock stealing functionality in a binary compatible fashion.

Creates a second version of open() and saveAs that accepts a new enum 
bit field to indicate ignoring the file lock.

Creates a new enum bit-field to indicate file handling status.

Creates 2 new error codes to indicate file locked and lockfile locked.

creates 2 new unittests to test the above code


Tested with unit tests and in conjunction with the parley portions of this bug fix.


Bugs: 240552
    http://bugs.kde.org/show_bug.cgi?id=240552


Repository: libkdeedu


Description
-------

Implement a lock on the language file.

The problem: When 2 or more instances of parley open that same language file,
the last instance to exit overwrites all of the previous changes.

This patch implements unit-tests that demonstrate the problem, and file locking
on the language file to fix the problem.

The unit tests are straight forward with different combinations of open, editing and saving
language files. The conditions that I anticipated would replicate the problem.

As a solution this patch uses KAutoSaveFile to implement file locking.  m_autosave replaces m_url to track the file.
Second and subsequent instances of KEduVocDocument can't get a lock for the file.  From a programmer perspective
it returns FileCannotWrite when file access fails.  From a user perspective it says that it
can't read collection from <file name>.

I added KEduVocDocument::close() to the public interface for symmetry with open().  It is not necessary and if interface changes are inconvenient at this time, it can be removed.  Destroying the KEduVocDocument, changing the Url with setUrl or saveAs, or opening another file all close the currently open file and eliminate the lock.

One foreseeable problem is that the current parley interface doesn't offer a way to remove the lock if parley crashes.
The vocabulary file would have to be renamed by hand.  However, this is an improvement from data loss to data inaccessible.
The obvious solution is to add a value to the error enumeration that means the file is locked, and then offer the user to option to steal the lock.  That would require changes to the KEduVocDocument interface. 


Diffs (updated)
-----

  keduvocdocument/keduvocdocument.h dfd45c3 
  keduvocdocument/keduvocdocument.cpp b73fc69 
  keduvocdocument/tests/CMakeLists.txt f05b787 
  keduvocdocument/tests/keduvocdocumentfilelockingtest.cpp PRE-CREATION 
  keduvocdocument/tests/keduvocdocumentvalidatortest.cpp 834564c 

Diff: https://git.reviewboard.kde.org/r/118686/diff/


Testing
-------

1. Unit tests
2. Opened 2 instances of parley and verified that only one could use the file and then after exiting
  that the other could then use the file and then that both successive sets of results had been saved. 


Thanks,

Andreas Xavier

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-edu/attachments/20140623/5b713db1/attachment-0001.html>