pdfmd 1.9.1 → 2.0.0

data/lib/pdfmd/long_desc.pdfmdshow.txt

@@ -0,0 +1,92 @@
+== General
+
+Show metatags of a PDF document.
+
+The following tags are being shown:
+
+* Author
+* CreateDate
+* Title
+* Subject
+* Keywords
+
+== Parameter
+
+--all, -a
+
+Show all relevant metatags for a document.
+
+Relevant tags are:  Author, CreateDate, Title, Subject, Keywords.
+
+This is the default action.
+
+
+
+--tag, -t
+
+Specify the metatag to show. The selected metatag must be one of the relevant tags. Other tags are ignored and nothing is returned.
+
+The value for the parameter is case insensitive: 'Author' == 'author'
+
+Multiple Tags can be specificed, separated by a comma.
+
+If multiple tags are specified in a different order than the default order, the specified order will be used. This has an impact on the order of the fields when e.g. the output is exported in CSV format.
+
+
+
+--format, -f
+
+Specify a different output format. Default: yaml
+
+Available formats are: json,yaml,csv,hash
+
+
+
+--includepdf, -i
+
+Include the filename of the PDF document in the output if this option is set to true. Default: false
+
+
+
+--log, -l
+
+Enable/Disable logging. Default: true
+
+
+
+--logfile, -p
+
+Specify path to logfile. Default: `./.pdfmd.log`
+
+
+
+== Example
+
+# Show default metatags for a pdf document
+
+$ pdfmd show <filename>
+
+# Show default metatags for example.pdf
+
+$ pdfmd show example.pdf
+
+# Show value for metatag 'Author' for the file example.pdf
+
+$ pdfmd show -t author example.pdf
+
+# Show value for metatags 'Author','Title' for the file example.pdf
+
+$ pdfmd show -t author,title example.pdf
+
+
+
+== Hiera
+
+--- # YAML
+pdfmd::config
+  show:
+    format    : yaml|json|csv|hash
+    tag       : author,subject,createdate,title,keywords
+    includepdf: true|false
+    log       : true|false
+

data/lib/pdfmd/long_desc.pdfmdsort.txt

@@ -0,0 +1,111 @@
+== General
+
+Will sort pdf documents into subdirectories according to the value of the meta-tag 'author'.
+
+If a document does not have an entry in the meta tag 'author', the file will not be processed.
+
+=== Parameter
+
+--destination, -d
+
+Speficy the root output directory to where the folderstructure is being created.
+
+This parameter is required if hiera is not configured.
+
+The command line parameter overwrites the hiera defaults
+
+Default: current working directory.
+
+
+
+--dryrun, -n
+
+If set to true the command will perform all actions as usual but without actually doing anything. Logentries will be prefaced with 'DRYRUN: ' for all simulated actions. Default: false
+
+
+
+--copy, -c
+
+Copy the files instead of moving them. Default: false
+
+
+
+--log, -l
+
+Disable/Enable the logging. Default: true
+
+
+
+--logfile, -p
+
+Set an alternate path for the logfile. If no path is chosen, the logfile gets created in the current working directory as `.pdfmd.log`.
+
+
+
+--interactive, -i
+
+Disable/Enable interactive sorting. This will ask for confirmation for each sorting action. Default: false
+
+
+
+--overwrite, -o
+
+If set to 'true' the command will overwrite any existing file at the target destination with the same name without asking. Default: false
+
+
+
+=== Replacement rules
+
+The subdirectories for the documents are generated from the values in the
+tag 'author' of each document.
+
+In order to ensure a clean directory structure, there are certain rules
+for altering the values.
+
+1. Whitespaces are replaced by underscores.
+
+2. Dots are replaced by underscores.
+
+3. All letters are converted to their lowercase version.
+
+4. Special characters are serialized.
+
+
+
+=== Hiera
+
+Set the default values mentioned below as sub-hash of the main configuration:
+
+--- #YAML
+pdfmd::config:
+  sort:
+    copy        : true|false
+    destination : /tmp
+    dryrun      : true|false
+    interactive : true|false
+    log         : true|false
+    logfile     : /var/log/pdfmd.log
+    overwrite   : true|false
+
+See the README file for an example how to define the values in Hiera or run `pdfmd explain hiera`.
+
+
+
+=== Example
+
+This command does the following:
+
+1. Take all pdf documents in the subdirectory ./documents.
+
+2. Create the output folder structure in `/tmp/test/`.
+
+3. Copy the files instead of moving them.
+
+4. Disable the logging.
+
+$ pdfmd sort -d /tmp/test -c -l false ./documents
+
+# Sort only a single file
+
+$ pdfmd sort -d /tmp/test -c -l false ./documents/test.pdf
+

data/lib/pdfmd/long_desc.pdfmdstat.txt

@@ -0,0 +1,23 @@
+Show statistics about the metadata of the PDF documents in a directory.
+
+== Usage
+
+Example: `pdfmd stat <directory>`
+
+
+== Parameter
+
+[<directory>]
+
+Path to the directory containing PDF documents or subdirectories with PDF documents.
+
+Example: `pdfmd stat ~/pdf`
+
+
+--r --recursive
+
+If set to true, pdfmd includes all PDF documents found in subdirectories of <directory> as well.
+
+Default: false
+
+

data/lib/pdfmd/pdfmdconfig.rb

@@ -0,0 +1,30 @@
+# == Class: Pdfmdconfig
+#
+# Show current default configuration of pdfmd
+#
+class Pdfmdconfig < Pdfmd
+
+  require 'yaml'
+
+  def initialize(filename)
+    super(filename)
+    @filename = filename
+  end
+
+  def show_config(key = '')
+
+    if key.empty?
+      self.log('debug','Showing current configuration in yaml format.')
+      @hieradata.to_yaml
+    elsif @hieradata.has_key?(key)
+      self.log('debug',"Showing current configuration in yaml format, section: #{key}.")
+      @hieradata[key].to_yaml
+    else
+      self.log('error',"Unknown Hiera Key used: '#{key}'.")
+      puts 'Unknown hiera key. Abort.'
+      abort
+    end
+
+  end
+
+end

data/lib/pdfmd/pdfmdedit.rb

@@ -0,0 +1,201 @@
+# == Class: pdfmdedit
+#
+# Edit Metadata of PDF documentsc
+#
+class Pdfmdedit < Pdfmd
+
+  attr_accessor :filename, :opendoc, :pdfviewer
+
+  @@edit_tags = Hash.new
+
+  def initialize(filename)
+    super(filename)
+    self.set_tags(@@default_tags)
+  end
+
+
+  # Start a viewer
+  def start_viewer(filename = '', viewer = '')
+    if File.exists?(filename) and !viewer.empty?
+
+      pid = IO.popen("#{viewer} #{filename}")
+      self.log('debug', "Application '#{viewer}' with PID #{pid.pid} started to show file '#{filename}'.")
+      pid.pid
+
+    elsif viewer.empty?
+      self.log('error', 'No viewer specified. Aborting document view.')
+    else
+      self.log('error', "Could not find file '#{filename}' for viewing.")
+    end
+
+  end
+
+
+  #
+  # Setting the tags to edit
+  def set_tags(tags = Array.new)
+
+    if tags.is_a?(String) and tags.downcase == 'all'
+      @@default_tags.each do |value|
+        @@edit_tags[value] = ''
+      end
+    elsif tags.is_a?(Array)
+      tags.each do |value|
+        @@edit_tags[value] = ''
+      end
+    elsif tags.is_a?(Hash)
+      # NOTE: might need some adjustment here
+      # Not sure this is used at all
+      @@edit_tags = tags
+    else
+
+
+      # Try to match tags
+      if tags.is_a?(String)
+
+        @@edit_tags = {}
+        tagsForEditing = tags.split(',')
+        tagsForEditing.each do |value|
+
+          if value.match(/:/)
+
+            self.log('debug', 'Found tag value assignment.')
+            tagmatching = value.split(':')
+
+            # Check date for validity
+            if tagmatching[0] == 'createdate'
+              validatedDate = validateDate(tagmatching[1])
+              if !validatedDate
+                self.log('error',"Date not recognized: '#{tagmatching[1]}'.")
+                abort 'Date format not recognized. Abort.'
+              else
+                self.log('debug',"Identified date: #{validatedDate} ")
+                @@edit_tags[tagmatching[0]] = validatedDate
+              end
+            else
+              self.log('debug', "Identified key #{tagmatching[0]} with value '#{tagmatching[1]}'.")
+              @@edit_tags[tagmatching[0]] = tagmatching[1]
+            end
+          else
+            @@edit_tags[value] = ''
+          end
+
+        end
+
+      end
+
+    end
+
+
+  end
+
+
+  #
+  # Update the tags
+  #   Reads @@edit_tags and asks for updates from the user if no value in
+  #   @@edit_tags is provided
+  def update_tags()
+
+    # Empty String for possible viewer Process PID
+    viewerPID = ''
+
+    # Iterate through all tags and request information from user
+    #   if necessary
+    @@edit_tags.each do |key,value|
+      if value.empty?
+
+            # At this poing:
+            # 1. If @opendoc
+            # 2. viewerPID.empty? (no viewer stated)
+            # => Start the viewer
+            if @opendoc and viewerPID.to_s.empty?
+              viewerPID = start_viewer(@filename, @pdfviewer)
+              self.log('debug', "Started external viewer '#{@pdfviewer}' with file '#{@filename}' and PID: #{viewerPID}")
+            end
+
+        puts 'Changing ' + key.capitalize + ', current value: ' + @@metadata[key].to_s
+        if key.downcase == 'createdate'
+
+          # Repeat asking for a valid date
+          validatedDate = false
+          while !validatedDate
+            validatedDate = validateDate(readUserInput('New date value: '))
+          end
+          @@metadata[key] = validatedDate
+
+        else
+
+          @@metadata[key] = readUserInput('New value: ')
+
+        end
+
+      else
+
+        # Setting the new metadata
+        @@metadata[key] = value
+
+      end
+    end
+
+    # Close the external PDF viewer if a PID has been set.
+    if !viewerPID.to_s.empty?
+      `kill #{viewerPID}`
+      self.log('debug', "Viewer process with PID #{viewerPID} killed.")
+    end
+
+  end
+
+  #
+  # Function to validate and interprete date information
+  def validateDate(date)
+
+    year    = '[1-2][90][0-9][0-9]'
+    month   = '0[1-9]|10|11|12'
+    day     = '[1-9]|0[1-9]|1[0-9]|2[0-9]|3[0-1]'
+    hour    = '[0-1][0-9]|2[0-3]|[1-9]'
+    minute  = '[0-5][0-9]'
+    second  = '[0-5][0-9]'
+    case date
+    when /^(#{year})(#{month})(#{day})$/
+      identifiedDate =  $1 + ':' + $2 + ':' + $3 + ' 00:00:00'
+    when /^(#{year})(#{month})(#{day})(#{hour})(#{minute})(#{second})$/
+      identifiedDate =  $1 + ':' + $2 + ':' + $3 + ' ' + $4 + ':' + $5 + ':' + $6
+    when /^(#{year})[\:|\.|\-](#{month})[\:|\.|\-](#{day})\s(#{hour})[\:](#{minute})[\:](#{second})$/
+      identifiedDate =  $1 + ':' + $2 + ':' + $3 + ' ' + $4 + ':' + $5 + ':' + $6
+    when /^(#{year})[\:|\.|\-](#{month})[\:|\.|\-](#{day})$/
+      day   = "%02d" % $3
+      month = "%02d" % $2
+
+      # Return the identified string
+      $1 + ':' + month + ':' + day + ' 00:00:00'
+
+    else
+
+      # This wasn't a date we recognize
+      false
+
+    end
+  end
+
+  #
+  # Write tags from the @@metadata back into the file
+  def write_tags(filename)
+
+    filename.empty? ? filename = @filename : ''
+
+    commandparameter = '-overwrite_original'
+    @@metadata.each do |key,value|
+      commandparameter = commandparameter + " -#{key}='#{value}'"
+    end
+
+    if !@@documentPassword.to_s.empty?
+      commandparameter = commandparameter + " -password '#{@@documentPassword}'"
+    end
+
+    command = "exiftool #{commandparameter} '#{filename}'"
+    `#{command}`
+    self.log('info',"Updating '#{filename}' with " + commandparameter.gsub(/\s\-password\s\'.*\'/,'').gsub(/\-overwrite\_original\s/,'').gsub(/\'\s\-/,"', ").gsub(/\-/,' ') )
+
+  end
+
+end