pdfmd 1.4.0 → 1.4.2

data/lib/pdfmd/check.rb

@@ -0,0 +1,10 @@
+filename = ENV.fetch('PDFMD_FILENAME')
+
+returnvalue = 0
+readMetadata(filename).each do|key,value|
+  if key.match(/author|subject|createdate|title/) and value.empty?
+    puts 'Missing value: ' + key 
+    returnvalue == 0 ? returnvalue = 1 : ''
+  end
+end
+exit returnvalue

data/lib/pdfmd/edit.rb

@@ -0,0 +1,40 @@
+#
+# Thor command 'edit' for changing the common
+# ExifTags within the PDF file
+#
+filename  = ENV.fetch('PDFMD_FILENAME')
+optTag    = ENV['PDFMD_TAG'] || nil
+optRename = ENV['PDFMD_RENAME'] == 'true' ? true : false
+pdfmd     = ENV['PDFMD']
+
+
+metadata = readMetadata(filename)
+
+if optTag == 'all'
+  tags = ['author','title','subject','createdate','keywords']
+else
+  tags = optTag.split(',')
+end
+tags.each do |currentTag|
+
+  # Change the tag to something we can use here
+  puts "Current value: '#{metadata[currentTag.downcase]}'"
+  answer   = readUserInput("Enter new value for #{currentTag} :")
+  if currentTag.downcase == 'createdate'
+    while not answer = identifyDate(answer)
+      puts 'Invalid date format'
+      answer = readUserInput("Enter new value for #{currentTag} :")
+    end
+  end
+  puts "Changing value for #{currentTag}: '#{metadata[currentTag]}' => #{answer}"
+  `exiftool -#{currentTag.downcase}='#{answer}' -overwrite_original '#{filename}'`
+end
+
+#
+# If required, run the renaming task afterwards
+# This is not pretty, but seems to be the only way to do this in THOR
+#
+if optRename
+  `#{pdfmd} rename '#{filename}'`
+end
+

data/lib/pdfmd/explain.author.md

@@ -0,0 +1,3 @@
+[Author]
+  The sender or creator of the document.
+

data/lib/pdfmd/explain.createdate.md

@@ -0,0 +1,6 @@
+[CreateDate]
+  Date of the document. THis is not the date when the file was created, but
+  the date found or printed in the document.
+
+  Take the date of a contract as an example.
+

data/lib/pdfmd/explain.hiera.md

@@ -0,0 +1,18 @@
+Information about hiera: https://docs.puppetlabs.com/hiera/1/index.html
+
+Installation:
+
+``` 
+$ gem install hiera
+```
+
+Configure default settings in hiera:
+
+  YAML
+  ---
+  pdfmd::config:
+    sort:
+      destination : /tmp/output
+      copy        : true
+      logfile     : /var/log/pdfmd.log
+

data/lib/pdfmd/explain.keywords.md

@@ -0,0 +1,9 @@
+[Keywords]
+  Anything else that might be of interesst.
+  In Orders the elements that have been orders. Contracts might contain the
+  Names and adress of the involved parties.
+  
+  When writing Invoices with their numbers, these will be automatically be 
+  picked up and can be integrated in the filename, e.g. "Invoicenumber 12334"
+  becomes "inv12334"
+

data/lib/pdfmd/explain.rb

@@ -0,0 +1,17 @@
+term  = ENV.fetch('PDFMD_EXPLAIN')
+pdfmd = ENV.fetch('PDFMD')
+
+case term
+when ''
+  puts 'Available subjects:'
+  puts '- author'
+  puts '- createdate'
+  puts '- hiera'
+  puts '- keywords'
+  puts '- subject'
+  puts '- title'
+  puts ' '
+  puts "Run `$ #{pdfmd} explain <subject>` to get more details."
+else
+  puts File.read("lib/pdfmd/explain.#{term.downcase}.md")
+end

data/lib/pdfmd/explain.subject.md

@@ -0,0 +1,8 @@
+[Subject]
+  What is the document about.
+
+  For example:
+  Manual  : What is the manual about?
+  Invoice : Invoice number?
+  Contract: Contract number of Subject of the contract?
+  Order   : Ordernumber of the document?

data/lib/pdfmd/explain.title.md

@@ -0,0 +1,5 @@
+[Title]
+  General type of the document, e.g. manual, invoice of contract.
+
+  Can be chosen freely, but some keywords are treated special when creating
+  the filename.

data/lib/pdfmd/methods.rb

@@ -0,0 +1,130 @@
+# == File: methods.rb
+#
+# General methods for supporting smaller tasks of the Thor commands
+
+#
+# Query Hiera installation
+# I don't give a sh** about cross platform at this point.
+#
+# Return the hash of the hiera values or false (if no hiera is found)
+#
+def queryHiera(keyword,facts = 'UNSET')
+
+  # Set default facts
+  facts == 'UNSET' ? facts = "fqdn=#{`hostname`}" : ''
+
+  # If hiera isn't found, return false
+  # otherwise return the hash
+  if !system('which hiera > /dev/null 2>&1')
+    puts 'Cannot find "hiera" command in $path.'
+    return false
+  else
+    return eval(`hiera #{keyword} #{facts}`)
+  end
+
+end
+
+
+
+#
+# Set Keywords Preface based on title and subject
+# If subject matches a number/character combination and contains no spaces,
+# the preface will be combined with the doktype.
+# If not: preface will contain the whole subject with dots and spaces being
+# replaced with underscores
+#
+def setKeywordsPreface(metadata, doktype)
+  if metadata['subject'].match(/^\d+[^+s]+.*/)
+    return doktype + metadata['subject']
+  else
+    subject = metadata['subject']
+
+    # Take care of special characters
+    I18n.enforce_available_locales = false
+    subject = I18n.transliterate(metadata['subject'])
+
+    # Replace everything else
+    subject = subject.gsub(/[^a-zA-Z0-9]+/,'_')
+    return subject
+  end
+end
+
+
+#
+# Function to read the metadata from a given file
+# hash readMetadata(string)
+#
+def readMetadata(pathFile = false) 
+  metadata = Hash.new 
+  metadata['keywords']    = ''
+  metadata['subject']     = ''
+  metadata['title']       = ''
+  metadata['author']      = ''
+  metadata['creator']     = ''
+  metadata['createdate']  = ''
+  if not File.file?(pathFile)
+    puts "Cannot access file #{pathFile}. Abort"
+    abort
+  end
+
+  # Fetch the Metada with the help of exiftools (unless something better is
+  # found
+  metaStrings = `exiftool '#{pathFile}' | egrep -i '^Creator\s+\:|^Author|Create Date|Subject|Keywords|Title'`
+
+  # Time to cherrypick the available data
+  entries = metaStrings.split("\n")
+  entries.each do |entry|
+    values = entry.split(" : ")
+    values[0].match(/Creator/) and metadata['creator'] == '' ? metadata['creator'] = values[1]: metadata['creator'] = ''
+    values[0].match(/Author/) and metadata['author'] == '' ? metadata['author'] = values[1]: metadata['author'] = ''
+    values[0].match(/Create Date/) and metadata['createdate'] == '' ? metadata['createdate'] = values[1]: metadata['createdate'] = ''
+    values[0].match(/Subject/) and metadata['subject'] == '' ? metadata['subject'] = values[1]: metadata['subject'] = ''
+    values[0].match(/Keywords/) and metadata['keywords'] == '' ? metadata['keywords'] = values[1]: metadata['keywords'] =''
+    values[0].match(/Title/) and metadata['title'] == '' ? metadata['title'] = values[1]: metadata['title'] =''
+  end
+  return metadata
+end
+
+
+#
+# Read user input
+#
+def readUserInput(textstring = 'Enter value: ')
+  return ask textstring
+end
+
+
+#
+# Identify a date
+# Function takes a string and tries to identify a date in there.
+# returns false if no date could be identified
+# otherwise the date is returned in the format as
+#
+#   YYYY:MM:DD HH:mm:ss
+#
+# For missing time values zero is assumed
+#
+def identifyDate(datestring)
+  identifiedDate = ''
+  year    = '[1-2][90][0-9][0-9]'
+  month   = '0[0-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 datestring
+  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
+    identifiedDate =  $1 + ':' + month + ':' + day + ' 00:00:00'
+  else
+    identifiedDate = false
+  end
+  return identifiedDate
+end

data/lib/pdfmd/rename.rb

@@ -0,0 +1,146 @@
+#
+# Thor command 'rename'
+#
+# TODO: Define outputdir from Hiera
+# TODO: Add option for copy when renaming
+# TODO: Add option to create outputdir if not existing
+# TODO: Define option to create outputdir via Hiera
+#
+filename        = ENV.fetch('PDFMD_FILENAME')
+allkeywords     = ENV.fetch('PDFMD_ALLKEYWORDS')
+outputdir       = ENV.fetch('PDFMD_OUTPUTDIR') == 'false' ? false : ENV.fetch('PDFMD_OUTPUTDIR')
+dryrun          = ENV.fetch('PDFMD_DRYRUN') == 'false' ? false : true
+numberKeywords  = ENV.fetch('PDFMD_NUMBERKEYWORDS').to_i
+
+metadata = readMetadata(filename).each do |key,value|
+
+  # Check if the metadata is complete
+  if key.match(/author|subject|createdate|title/) and value.empty?
+    puts 'Missing value for ' + key
+    puts 'Abort'
+    exit 1
+  end
+
+end
+
+date   = metadata['createdate'].gsub(/\ \d{2}\:\d{2}\:\d{2}.*$/,'').gsub(/\:/,'')
+author = metadata['author'].gsub(/\./,'_').gsub(/\-/,'').gsub(/\s/,'_')
+I18n.enforce_available_locales = false
+author = I18n.transliterate(author) # Normalising
+
+keywords_preface = ''
+# This statement can probably be optimised
+case metadata['title']
+when /(Tilbudt|Angebot)/i
+  doktype = 'til'
+  keywords_preface = setKeywordsPreface(metadata,doktype.gsub(/\-/,''))
+when /Orderbekrefelse/i
+  doktype = 'odb'
+  keywords_preface = setKeywordsPreface(metadata,doktype.gsub(/\-/,''))
+when /faktura/i
+  doktype = 'fak'
+  keywords_preface = setKeywordsPreface(metadata,doktype.gsub(/\-/,''))
+when /order/i
+  doktype = 'ord'
+  keywords_preface = setKeywordsPreface(metadata,doktype.gsub(/\-/,''))
+when /(kontrakt|avtale|vertrag|contract)/i
+  doktype = 'avt'
+  keywords_preface = setKeywordsPreface(metadata,doktype.gsub(/\-/,''))
+when /kvittering/i
+  doktype = 'kvi'
+  keywords_preface = setKeywordsPreface(metadata,doktype.gsub(/\-/,''))
+when /manual/i
+  doktype = 'man'
+  keywords_preface = setKeywordsPreface(metadata,doktype.gsub(/\-/,''))
+when /(billett|ticket)/i
+  doktype = 'bil'
+  keywords_preface = setKeywordsPreface(metadata,doktype.gsub(/\-/,''))
+when /(informasjon|information)/i
+  doktype = 'inf'
+  keywords_preface = setKeywordsPreface(metadata,doktype.gsub(/\-/,''))
+else
+  doktype = 'dok'
+  keywords_preface = setKeywordsPreface(metadata,doktype.gsub(/\-/,''))
+end
+if not metadata['keywords'].empty? 
+  keywords_preface == '' ? keywords = '' : keywords = keywords_preface
+  keywordsarray    = metadata['keywords'].split(',')
+
+  #
+  # Sort array
+  #
+  keywordssorted = Array.new
+  keywordsarray.each_with_index do |value,index|
+    value = value.lstrip.chomp
+    value = value.gsub(/(Faktura|Rechnungs)(nummer)? /i,'fak')
+    value = value.gsub(/(Kunde)(n)?(nummer)? /i,'kdn')
+    value = value.gsub(/(Kunde)(n)?(nummer)?-/i,'kdn')
+    value = value.gsub(/(Ordre|Bestellung)(s?nummer)? /i,'ord')
+    value = value.gsub(/(Kvittering|Quittung)(snummer)? /i,'kvi')
+    value = value.gsub(/\s/,'_')
+    value = value.gsub(/\//,'_')
+    keywordsarray[index] = value
+    if value.match(/^(fak|kdn|ord|kvi)/)
+      keywordssorted.insert(0, value)
+    else
+      keywordssorted.push(value)
+    end
+  end
+
+  counter = 0
+  keywordssorted.each_with_index do |value,index|
+
+    # Exit condition limits the number of keywords used in the filename
+    # unless all keywords shall be added
+    if not allkeywords.empty?
+      counter > numberKeywords-1 ? break : counter = counter + 1
+    end
+    if value.match(/(kvi|fak|ord|kdn)/i)
+      keywords == '' ? keywords = '-' + value : keywords = value + '-' + keywords
+    else
+      keywords == '' ? keywords = '-' + value : keywords.concat('-' + value)
+    end
+  end
+  # Normalise the keywords as well
+  #
+  I18n.enforce_available_locales = false
+  keywords = I18n.transliterate(keywords)
+
+  # There are no keywords
+  # Rare, but it happens
+else
+
+  # There are no keywords.
+  # we are using the title and the subject
+  if keywords_preface != '' 
+    keywords = keywords_preface
+  end
+
+end
+extension   = 'pdf'
+if keywords != nil and keywords[0] != '-'
+  keywords = '-' + keywords
+end
+keywords == nil ? keywords = '' : ''
+newFilename = date + '-' +
+  author + '-' +
+  doktype +
+  keywords + '.' + 
+  extension
+
+# Output directory checks
+if outputdir 
+  if not File.exist?(outputdir)
+    puts "Error: output dir '#{outputdir}' not found. Abort."
+    exit 1
+  end
+else
+  # Output to Inputdir
+  outputdir = File.dirname(filename)
+end
+
+if not dryrun and filename != newFilename.downcase
+  `mv -v '#{filename}' '#{outputdir}/#{newFilename.downcase}'`
+else
+  puts filename + "\n   => " + newFilename.downcase
+end

data/lib/pdfmd/show.rb

@@ -0,0 +1,24 @@
+filename  = ENV.fetch('PDFMD_FILENAME')
+optTag    = ENV['PDFMD_TAGS'] || nil 
+optAll    = ENV['PDFMD_ALL'] == 'true' ? true : nil
+
+metadata  = readMetadata(filename)
+
+# Output all metatags
+if optAll or optTag.nil?
+
+  puts "Author      : " + metadata['author'].to_s
+  puts "Creator     : " + metadata['creator'].to_s
+  puts "CreateDate  : " + metadata['createdate'].to_s
+  puts "Subject     : " + metadata['subject'].to_s
+  puts "Title       : " + metadata['title'].to_s
+  puts "Keywords    : " + metadata['keywords'].to_s
+
+elsif not optTag.nil? # Output specific tag(s)
+
+  tags = optTag.split(',')
+  tags.each do |tag|
+    puts metadata[tag.downcase]
+  end
+
+end

data/lib/pdfmd/sort.rb

@@ -0,0 +1,100 @@
+inputDir = ENV.fetch('PDFMD_INPUTDIR')
+
+require_relative('./methods.rb')
+require 'fileutils'
+
+opt_destination = ENV.fetch('PDFMD_DESTINATION')
+opt_copy        = ENV.fetch('PDFMD_COPY')
+opt_log         = ENV.fetch('PDFMD_LOG')
+opt_interactive = ENV.fetch('PDFMD_INTERACTIVE')
+
+hieraDefaults = queryHiera('pdfmd::config')
+
+copyAction  = opt_copy.empty? ? false : true
+if opt_copy.nil? and hieraDefaults['sort']['copy'] == true
+  copyAction = true
+  puts 'Setting action to copy based on Hiera.'
+end
+
+interactiveAction = opt_interactive.empty? ? false : true
+if opt_interactive.empty? and hieraDefaults['sort']['interactive'] == true
+  interactiveAction = true
+  puts 'Setting interactive to true based on Hiera.'
+end
+
+# Fetch alternate destination from hiera if available
+destination = opt_destination
+if destination.nil? or destination == ''
+
+  hieraHash = queryHiera('pdfmd::config')
+  if !hieraHash['sort']['destination'].nil?
+    destination = hieraHash['sort']['destination']
+  else
+    puts 'No information about destination found.'
+    puts 'Set parameter -d or configure hiera.'
+    puts 'Abort.'
+    exit 1
+  end
+
+end
+
+logenable = opt_log
+logfile   = !hieraDefaults['sort']['logfile'].nil? ? hieraDefaults['sort']['logfile'] : Dir.pwd.chomp('/') + '/' + Pathname.new(__FILE__).basename + '.log'
+
+# Check that logfilepath exists and is writeable
+if !File.writable?(logfile)
+  puts "Cannot write '#{logfile}. Abort."
+  exit 1
+end
+logenable ? $logger = Logger.new(logfile) : ''
+
+# Input validation
+!File.exist?(inputDir) ? abort('Input directory does not exist. Abort.'): ''
+File.directory?(inputDir) ? '' : abort('Input is a single file')
+File.file?(destination) ? abort("Output '#{destination}' is an existing file. Cannot create directory with the same name. Abort") : ''
+unless File.directory?(destination)
+  FileUtils.mkdir_p(destination)
+  $logger.info("Destination '#{destination}' has been created.")
+end
+
+# Iterate through all files
+Dir[inputDir.chomp('/') +  '/*.pdf'].sort.each do |file|
+
+  if interactiveAction
+    answer = readUserInput("Process '#{file}' ([y]/n): ")
+    answer = answer.empty? ? 'y' : answer 
+    answer.match(/y/) ? '' : next
+  end
+
+  metadata = readMetadata(file)
+  if metadata['author'] and not metadata['author'].empty?
+    author                          = metadata['author'].gsub(' ','_').gsub('.','_')
+    I18n.enforce_available_locales  = false # Serialize special characters
+    author                          = I18n.transliterate(author).downcase
+    folderdestination               = destination.chomp('/') + '/' + author
+
+    unless File.directory?(folderdestination)
+      FileUtils.mkdir_p(folderdestination)
+      logenable ? $logger.info("Folder '#{folderdestination}' has been created."): ''
+    end
+
+    filedestination                 = destination.chomp('/') + '/' + author + '/' + Pathname.new(file).basename.to_s
+
+    # Final check before touching the filesystem
+    if not File.exist?(filedestination)
+      $logger.info("File '#{file}' => '#{filedestination}'")
+
+      # Move/Copy the file
+      if copyAction
+        FileUtils.cp(file, filedestination)
+      else
+        FileUtils.mv(file,filedestination)
+      end
+
+    else
+      logenable ? $logger.warn("File '#{filedestination}' already exists. Ignoring.") : ''
+    end
+  else
+    logenable ? $logger.warn("Missing tag 'Author' for file '#{file}'. Skipping.") : (puts "Missing tag 'Author' for file '#{file}'. Skipping")
+  end
+end