Difference between revisions of "Media Verify Tool"

From Gramps
Jump to: navigation, search
(Create page)
 
(Possible future enhancements)
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{Third-party plugin}}
 +
The idea of the '''Media Verify Tool''' is to verify a one-to-one relationship between media objects and files in the media directory. The main purpose of the tool is to locate files that have been moved and fix the paths.
 +
 
== Purpose ==
 
== Purpose ==
  
This tool uses md5 checksums to verify the integrity of files under the media directory.  It also allows users to use a file manager of their choice to manage media objects.
+
This tool uses [https://en.wikipedia.org/wiki/MD5 MD5 checksums] to verify the integrity of files under the media directory.  It also allows users to use a file manager of their choice to manage media objects.
  
 
== Preparation ==
 
== Preparation ==
  
This tool assumes that you are using relative media paths and have a base path setIn the "General" tab, under the Edit->Preferences menu option, you can set the "Base path for relative media paths".
+
This tool assumes that you store all your media files under a media directoryYou can specify this directory by setting the {{man label|Base path for relative media paths}} in the {{man label|General}} tab, under the {{man menu|Edit->Preferences}} menu option.
  
== Description ==
+
== Usage ==
 
+
[[File:MediaVerifyTool.png|left]]
[[Image:MediaVerifyTool.png]]
+
You access the tool from the {{man menu|Tools > Utilities > Media Verify...}} menu.
  
 +
Selecting the {{man button|Close}} button will exit the tool.
 +
{{-}}
 
=== Generate ===
 
=== Generate ===
 
+
[[File:Results-from-generate-media-verify-tool.png|left]]
Clicking the "Generate" button will generate md5 checksums for all media objects.  You should run this after you have added or changed any media files.  Media objects without md5 checksums will be listed as part of the media verification.
+
Clicking the {{man button|Generate}} button will generate MD5 checksums for all media objects.  You should run this after you have added or changed any media files.  Media objects without MD5 checksums will be listed as part of the media verification.
 +
{{-}}
  
 
=== Verify ===
 
=== Verify ===
  
Clicking the "Verify" button will perform various checks against your media objects in Gramps and media files under your media directory.
+
Clicking the {{man button|Verify}} button will perform various checks against your media objects in Gramps and media files under your media directory.
  
* Files that have moved are listed in the "Moved Files" section.  Where there are multiple files with the same checksum under the media directory, the first one listed with the same name as the original will be displayed.
+
==== Moved/Renamed Files ====
  
* Media objects are listed in the "Missing Files" section, when there is no file found with a matching checksum.
+
[[Image:MediaVerifyTool1.png]]
  
* Files with duplicate checksums are listed in the "Duplicate Files" section.
+
Files that have moved or renamed are listed in the {{man label|Moved/Renamed Files}} tab.  Where there are multiple files with the same checksum under the media directory, the first one listed with the same name as the original will be displayed.
  
* Files that are under the media directory, but not yet in Gramps are listed in the "Extra Files" section.
+
Double clicking on a row will edit the associated media object.
  
* Media objects with no checksum are listed in the "No md5 Generated" section.
+
==== Missing Files ====
 +
 
 +
[[Image:MediaVerifyTool2.png]]
 +
 
 +
Media objects are listed in the {{man label|Missing Files}} tab, when there is no file found with a matching checksum.
 +
 
 +
Double clicking on a row will edit the associated media object.
 +
 
 +
==== Duplicate Files ====
 +
 
 +
[[Image:MediaVerifyTool3.png]]
 +
 
 +
Files with duplicate checksums are listed in the {{man label|Duplicate Files}} tab.
 +
 
 +
Double clicking on a row will display the image in the default viewer.
 +
 
 +
==== Extra Files Files ====
 +
 
 +
[[Image:MediaVerifyTool4.png]]
 +
 
 +
Files that are under the media directory, but not yet in Gramps are listed in the {{man label|Extra Files}} tab.
 +
 
 +
Double clicking on a row will display the image in the default viewer.
 +
 
 +
==== No MD5 Generated ====
 +
 
 +
[[Image:MediaVerifyTool5.png]]
 +
 
 +
Media objects with no checksum are listed in the {{man label|No MD5 Generated}} tab.
 +
 
 +
Double clicking on a row will edit the associated media object.
 +
 
 +
=== Export ===
 +
 
 +
Clicking the {{man button|Export}} button will export the report as a text file.
  
 
=== Fix ===
 
=== Fix ===
  
Clicking the "Fix" button will fix the paths in the media objects to match the new paths listed in the "Moved Files" section.
+
Clicking the {{man button|Fix}} button will fix the paths in the media objects to match the new paths listed in the {{man label|Moved/Renamed Files}} section.
 +
 
 +
== Possible future enhancements ==
 +
This tool could be enhanced to perform other tasks, such as:
 +
 
 +
# Merging media objects with duplicate files.
 +
# Updating the checksum for modified files.
 +
# Removing unused duplicate files.
 +
# Creating media objects for unused files.
 +
# Add a help button pointing here
 +
 
 +
 
 +
[[Category:Plugins]]
 +
[[Category:Developers/General]]

Latest revision as of 19:23, 24 July 2015

Gramps-notes.png

Please use carefully on data that is backed up, and help make it better by reporting any comments or problems to the author, or issues to the bug tracker
Unless otherwise stated on this page, you can download this plugin by following these instructions
Please note that some plugins have prerequisites that need to be installed before they can be used.

The idea of the Media Verify Tool is to verify a one-to-one relationship between media objects and files in the media directory. The main purpose of the tool is to locate files that have been moved and fix the paths.

Purpose

This tool uses MD5 checksums to verify the integrity of files under the media directory. It also allows users to use a file manager of their choice to manage media objects.

Preparation

This tool assumes that you store all your media files under a media directory. You can specify this directory by setting the Base path for relative media paths in the General tab, under the Edit->Preferences menu option.

Usage

MediaVerifyTool.png

You access the tool from the Tools > Utilities > Media Verify... menu.

Selecting the Close button will exit the tool.

Generate

Results-from-generate-media-verify-tool.png

Clicking the Generate button will generate MD5 checksums for all media objects. You should run this after you have added or changed any media files. Media objects without MD5 checksums will be listed as part of the media verification.

Verify

Clicking the Verify button will perform various checks against your media objects in Gramps and media files under your media directory.

Moved/Renamed Files

MediaVerifyTool1.png

Files that have moved or renamed are listed in the Moved/Renamed Files tab. Where there are multiple files with the same checksum under the media directory, the first one listed with the same name as the original will be displayed.

Double clicking on a row will edit the associated media object.

Missing Files

MediaVerifyTool2.png

Media objects are listed in the Missing Files tab, when there is no file found with a matching checksum.

Double clicking on a row will edit the associated media object.

Duplicate Files

MediaVerifyTool3.png

Files with duplicate checksums are listed in the Duplicate Files tab.

Double clicking on a row will display the image in the default viewer.

Extra Files Files

MediaVerifyTool4.png

Files that are under the media directory, but not yet in Gramps are listed in the Extra Files tab.

Double clicking on a row will display the image in the default viewer.

No MD5 Generated

MediaVerifyTool5.png

Media objects with no checksum are listed in the No MD5 Generated tab.

Double clicking on a row will edit the associated media object.

Export

Clicking the Export button will export the report as a text file.

Fix

Clicking the Fix button will fix the paths in the media objects to match the new paths listed in the Moved/Renamed Files section.

Possible future enhancements

This tool could be enhanced to perform other tasks, such as:

  1. Merging media objects with duplicate files.
  2. Updating the checksum for modified files.
  3. Removing unused duplicate files.
  4. Creating media objects for unused files.
  5. Add a help button pointing here