Register Guidelines E-Books Search Today's Posts Mark Forums Read

Go Back   MobileRead Forums > E-Book Software > Calibre > Plugins

Notices

Reply
 
Thread Tools Search this Thread
Old 04-19-2017, 11:23 AM   #1
DaltonST
Deviser
DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.
 
DaltonST's Avatar
 
Posts: 936
Karma: 71402
Join Date: Aug 2013
Location: Texas
Device: 8" Win10 Tablet w/Calibre64
[GUI Plugin] Audit Log

[GUI Plugin] Audit Log


Summary:

Undo/Reverse most metadata deletes and updates days or weeks later for selected books and log entries. Creates a log entry for every addition, change or delete for most Calibre standard metadata columns, and for all custom metadata columns.

The 'Audit Log Activity Detail' listing may be viewed, optionally exported to the Clipboard as a tab-delimited file, and then purged (or not). If it is purged, no Undo's may be performed for the deleted items, but rather for only future metadata changes.

Undo's may themselves be Undone, of course.


Logging Metadata Scope:

The Standard Calibre metadata columns that are tracked by Audit Log are:
  • title
  • author_sort [1]
  • pubdate [2]
  • series
  • series index
  • tags
  • publisher
  • identifiers
  • comments [3]
  • languages
  • formats

[1] Author_sort is used as a proxy for authors, as it greatly simplifies the logging for books with multiple co-authors. Example: a book with 100 co-authors would require 100 lines in the log, whereas using author_sort requires only 1 line in the log.

[2] Pubdate is expressed in the original +0000 UTC, not the Local Time of the User initiating a change in pubdate.

[3] Comments can be quite long, so only the first 25 characters are shown in the 'Audit Log Activity Detail'. Internally, AL captures the full length, which is available for viewing via a DB browsing utility if necessary. The table to browse is '_audit_log'.

Optionally, AL also tracks all changes to all Custom Columns.

You can track Custom Columns and not Standard Columns, and vice versa. Plus, both of course.


Undo/Reverse Metadata Scope:

The Standard Calibre metadata columns that may be Undone:
  • title
  • pubdate
  • series
  • publisher
  • identifiers
  • comments
  • languages
All Custom Calibre metadata columns may be Undone.



Types of Activities Triggering Logging:
  • User metadata changes via the Calibre GUI for the current Library, including Standard Calibre functionality as well as Calibre Plug-ins.
  • User copying of books from the current Library to another Library. The activity in the other Library will be logged in that other Library. If the copy is a "copy it and then delete it" type, the deletion of the book from the current Library will be logged in the current Library.
  • Executing Calibre via its command line utilities if it results in a metadata.db database update of any of the metadata currently within the scope of AL.
  • Executing any non-Calibre (external third-party) programs that directly update the metadata.db database for any of the metadata currently within the scope of AL.

Example Uses:
  • Track what metadata within the scope of AL has been changed, when it was changed, and what the old and new metadata values were. Why do this? Because you just want to, or actually need to.
  • If you know who was using your Calibre Library at a specific time, then you have an audit trail of what they did. If so, you can reverse what they did that was logged by AL.
  • Reconstruct the metadata for a book that was erroneously deleted (assuming you have the original ebook format itself to use to add back to Calibre), and for which you had no Calibre backup.
  • Easily confirm the results of a 'Merge Books' add/copy scenario, and change the pre-existing book back to either what it was or what it should be if so desired.
  • Use as a testing tool for Calibre plug-ins that change metadata columns that are within the scope of AL.
  • Discover or keep track of unknown non-Calibre software (e.g., a third-party ebook application) that updates metadata.db via direct database updates.

Requires Minimum Calibre Version: 2.83


Version History:
Spoiler:
Version 1.0.8 - 2017-09-12 New triggers added (silently) for table 'data' for formats.
Version 1.0.7 - 2017-05-22 New trigger added (silently) for comments that are 'updated' by certain plugins. Calibre itself does only an 'insert or replace', not an 'update'.
Version 1.0.6 - 2017-04-29 New menu option: Show Audit Log Status for Calibre Libraries.
Version 1.0.5 - 2017-04-28 Functionality tweaks.
Version 1.0.4 - 2017-04-27 Various functionality enhancements.
Version 1.0.3 - 2017-04-26 New menu option: Undo/Reverse Delete or Update. This is available for all custom columns plus title, pubdate, language, series, comments, identifiers, and publisher. Also, a few triggers have been reworked to improve functionality. To install this Version, AL must be totally deactivated to drop all of AL's SQLite objects in every Library for which it was ever activated, then Calibre restarted, and then AL re-activated.
Version 1.0.2 - 2017-04-20 All triggers have been reworked to improve both performance and functionality. AL must be totally deactivated to drop all of AL's SQLite objects, Calibre restarted, and then AL re-activated.
Version 1.0.1 - 2017-04-19 The scope of metadata now includes all custom columns if desired. Standard Calibre columns and/or custom columns may be activated. However, deactivation deactivates everything.
Version 1.0.0 - 2017-04-18 Initial release.
Attached Thumbnails
Click image for larger version

Name:	undo_example.jpg
Views:	107
Size:	901.5 KB
ID:	156382   Click image for larger version

Name:	al_customize.jpg
Views:	105
Size:	715.0 KB
ID:	156383   Click image for larger version

Name:	al_example_1.jpg
Views:	112
Size:	1.25 MB
ID:	156384  
Attached Files
File Type: zip audit_log.zip (67.0 KB, 1805 views)

Last edited by DaltonST; 09-12-2017 at 04:44 PM. Reason: Version 1.0.8 Functionality Enhancements
DaltonST is offline   Reply With Quote
Advert
Old 04-19-2017, 11:23 AM   #2
DaltonST
Deviser
DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.
 
DaltonST's Avatar
 
Posts: 936
Karma: 71402
Join Date: Aug 2013
Location: Texas
Device: 8" Win10 Tablet w/Calibre64
Reserved for future use.
DaltonST is offline   Reply With Quote
Old 04-19-2017, 05:11 PM   #3
DaltonST
Deviser
DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.
 
DaltonST's Avatar
 
Posts: 936
Karma: 71402
Join Date: Aug 2013
Location: Texas
Device: 8" Win10 Tablet w/Calibre64
Version 1.0.1 Custom Columns now in Scope

Version 1.0.1 - 2017-04-19 The scope of metadata now includes all custom columns if desired. Standard Calibre columns and/or custom columns may be activated. However, deactivation deactivates everything.



DaltonST
DaltonST is offline   Reply With Quote
Old 04-20-2017, 05:04 PM   #4
DaltonST
Deviser
DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.
 
DaltonST's Avatar
 
Posts: 936
Karma: 71402
Join Date: Aug 2013
Location: Texas
Device: 8" Win10 Tablet w/Calibre64
Version 1.0.2-Technical Enhancements Requring Deactivation, Restart, then Activation

Version 1.0.2 - 2017-04-20 All triggers and the log table have been reworked to improve both performance and functionality. AL must be totally deactivated to drop all of AL's SQLite objects, Calibre restarted, and then AL re-activated.



DaltonST
DaltonST is offline   Reply With Quote
Old 04-26-2017, 02:31 PM   #5
DaltonST
Deviser
DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.DaltonST knows who John Galt is.
 
DaltonST's Avatar
 
Posts: 936
Karma: 71402
Join Date: Aug 2013
Location: Texas
Device: 8" Win10 Tablet w/Calibre64
Version 1.0.3 - Undo/Reverse Deletes and Updates

New menu option: Undo/Reverse Delete or Update. This is available for all custom columns plus title, pubdate, language, series, comments, identifiers, and publisher.

A few SQLite triggers have been reworked to improve functionality, so to install this Version, AL must be totally deactivated to drop all of AL's SQLite objects in every Library for which it was ever activated, then Calibre restarted, and then AL re-activated.

See the attached Undo/Reverse example.


DaltonST
Attached Thumbnails
Click image for larger version

Name:	undo_example.jpg
Views:	62
Size:	901.5 KB
ID:	156385  
DaltonST is offline   Reply With Quote
Advert
Old 04-26-2017, 11:02 PM   #6
Dopedangel
Wizard
Dopedangel ought to be getting tired of karma fortunes by now.Dopedangel ought to be getting tired of karma fortunes by now.Dopedangel ought to be getting tired of karma fortunes by now.Dopedangel ought to be getting tired of karma fortunes by now.Dopedangel ought to be getting tired of karma fortunes by now.Dopedangel ought to be getting tired of karma fortunes by now.Dopedangel ought to be getting tired of karma fortunes by now.Dopedangel ought to be getting tired of karma fortunes by now.Dopedangel ought to be getting tired of karma fortunes by now.Dopedangel ought to be getting tired of karma fortunes by now.Dopedangel ought to be getting tired of karma fortunes by now.
 
Dopedangel's Avatar
 
Posts: 1,606
Karma: 28506885
Join Date: Dec 2006
Location: Singapore
Device: Coolreader(Nexus 5)\Coolreader(Nook Touch)
This plugin seem really useful specially for mass metadata downloads. But I think the name doesn't describe what it does as well as it should. You should name it something like undo metadata or Log for metadata undo.
Dopedangel is offline   Reply With Quote
Old 08-24-2017, 07:11 PM   #7
Fbone
Is that a sandwich?
Fbone ought to be getting tired of karma fortunes by now.Fbone ought to be getting tired of karma fortunes by now.Fbone ought to be getting tired of karma fortunes by now.Fbone ought to be getting tired of karma fortunes by now.Fbone ought to be getting tired of karma fortunes by now.Fbone ought to be getting tired of karma fortunes by now.Fbone ought to be getting tired of karma fortunes by now.Fbone ought to be getting tired of karma fortunes by now.Fbone ought to be getting tired of karma fortunes by now.Fbone ought to be getting tired of karma fortunes by now.Fbone ought to be getting tired of karma fortunes by now.
 
Posts: 7,215
Karma: 89000000
Join Date: Jun 2010
Device: Searching ...
Where does it obtain the book number?
Fbone is offline   Reply With Quote
Reply

Tags
audit, undo

Thread Tools Search this Thread
Search this Thread:

Advanced Search

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
[GUI Plugin] KindleUnpack - The Plugin DiapDealer Plugins 403 07-29-2017 01:19 PM
[GUI Plugin] Hyphenate This! bookbinder Plugins 0 05-06-2015 01:07 PM
[GUI Plugin] KiNotes -axel- Plugins 0 07-14-2013 06:39 PM
How to log within plugin? charlweed Development 4 08-24-2012 08:19 PM
[GUI Plugin] Plugin Updater **Deprecated** kiwidude Plugins 159 06-19-2011 12:27 PM


All times are GMT -4. The time now is 12:10 AM.


MobileRead.com is a privately owned, operated and funded community.