pdfmd 1.9.1 → 2.0.0

data/lib/pdfmd/pdfmdmethods.rb

@@ -0,0 +1,125 @@
+# == Module: pdfmdmethods
+# 
+# Method to extend functionalities
+module Pdfmdmethods
+
+  # 
+  # Determine the valid setting
+  # 1. Priority: manual setting
+  # 2. Priority: Hiera setting
+  #
+  # If there is no manual setting, the value of 'manualSetting'
+  #   should be set to 'nil'
+  #
+  def determineValidSetting(manualSetting,key)
+
+    if !@hieradata.nil? 
+      hieraKey    = '@hieradata'
+      hieraValue  = ''
+
+      key.split(':').each do |keyname|
+
+        hieraKeyCheck = eval(hieraKey)
+        if !hieraKeyCheck.nil? and hieraKeyCheck.has_key?(keyname)
+          hieraKey = hieraKey + "['#{keyname}']"
+        else
+          # Key has not been found
+          hieraKey = ''
+          break
+        end 
+      end
+
+      hieraValue = eval(hieraKey)
+
+    else
+      hieraValue = nil
+    end
+
+    if !manualSetting.nil?
+      self.log('debug', "Chosing manual setting '#{key} = #{manualSetting}'.")
+      manualSetting
+    elsif !hieraValue.nil? or
+      !hieraValue == ''
+
+      self.log('debug', "Chosing hiera setting '#{key} = #{hieraValue}'.")
+      hieraValue
+
+    else
+      self.log('debug', "No setting chosen for '#{key}' in hiera.")
+      false 
+    end
+
+  end
+
+
+  #
+  # Logging stuff
+  def log(status = 'info', message)
+
+    # Setting the loglevel
+    case @loglevel
+    when /info/i
+      level = 'Logger::INFO'
+    when /warn/i
+      level = 'Logger::WARN'
+    when /error/i
+      level = 'Logger::ERROR'
+    when /debug/i
+      level = 'Logger::DEBUG'
+    else
+      level = 'Logger::INFO'
+    end
+    logger = Logger.new(@logfile)
+    logger.level = eval level
+    logger.send(status, message)
+    logger.close
+
+  end
+
+
+
+  #
+  # Query hiera for settings if available
+  def queryHiera(keyword, facts = 'UNSET')
+
+    pathHieraConfig = [
+      '/etc/hiera.yaml',
+      '/etc/puppet/hiera.yaml',
+      '/etc/puppetlabs/puppet/hiera.yaml',
+    ]
+    hieraConfig = ''
+    pathHieraConfig.each do |path|
+      if File.exist? path
+        hieraConfig = path
+        break
+      end
+    end
+
+    # Set default facts
+    facts == 'UNSET' ? facts = "fqdn=#{`hostname`}".chomp : ''.chomp
+
+    # If Hiera is not found (damn cat, get of my keyboard!), return false,
+    # otherwise return the hash from Hiera
+    if !system('which hiera > /dev/null 2>&1')
+      self.log('warn','Cannot find hiera command in $path.')
+      puts 'Cannot find "hiera" command in $path.'
+      return eval('{}')
+    else
+
+      self.log('debug', 'Reading hiera values for pdfmd::config.')
+      commandreturn = ''
+      commandreturn = `hiera -c #{hieraConfig} #{keyword} #{facts} 2>/dev/null`
+
+      if $?.exitstatus == 1
+        self.log('warn', 'Could not retrieve configuration from with hiera.')
+        eval('{}')
+      else
+        self.log('debug', 'Could retrieve configuration from hiera.')
+        eval(commandreturn)
+      end
+
+    end
+
+  end # End of queryHiera
+
+end

data/lib/pdfmd/pdfmdrename.rb

@@ -0,0 +1,243 @@
+# == Class: pdfmdrename
+#
+# Class for renaming the file according to the metadata
+#
+class Pdfmdrename < Pdfmd
+
+  attr_accessor :filename, :dryrun, :allkeywords, :outputdir, :nrkeywords, :copy
+
+  # document key mappings to determine the document type based on the
+  # string in the meta field 'title'
+  @@keymapping = {
+    'cno' => ['Customer','Customernumber'],
+    'con' => ['Contract'],
+    'inf' => ['Information'],
+    'inv' => ['Invoice', 'Invoicenumber'],
+    'man' => ['Manual'],
+    'off' => ['Offer', 'Offernumber'],
+    'ord' => ['Order', 'Ordernumber'],
+    'rec' => ['Receipt', 'Receiptnumber'],
+    'tic' => ['Ticket'],
+    }
+
+  def initialize(filename)
+    super(filename)
+    @nrkeywords     ||= 3
+
+    # Find the valid keymapping
+    # Use @@keymapping as default and only overwrite when provided by hiera.
+    hierakeymapping = self.determineValidSetting(nil, 'rename:keys')
+    hierakeymapping ?  @@keymapping = hierakeymapping : ''
+
+    # FIXME: this default doctype assignment might need to be rewritten as the keymapping above.
+    @defaultDoctype = self.determineValidSetting('doc', 'rename:defaultdoctype')
+    @fileextension  = 'pdf'
+  end
+
+  def rename
+
+    # Build new filename elements
+    newFilename             = Hash.new
+    newFilename[:date]      = @@metadata['createdate'].gsub(/\ \d{2}\:\d{2}\:\d{2}.*$/,'').gsub(/\:/,'')
+    newFilename[:author]    = get_author()
+    newFilename[:doctype]   = get_doctype()
+    newFilename[:title]     = @@metadata['title'].downcase
+    newFilename[:subject]   = @@metadata['subject'].downcase.gsub(/(\s|\-|\.|\&|\%)/,'_')
+    newFilename[:keywords]  = get_keywords(get_keywordsPreface(newFilename))
+    newFilename[:extension] = @fileextension
+    newFilename[:outputdir] = get_outputdir(@outputdir)
+
+    command = @copy ? 'cp' : 'mv'
+
+    filetarget  = get_filename(newFilename)
+    if @dryrun # Do nothing on dryrun
+      if @filename == filetarget
+        self.log('info', "Dryrun: File '#{@filename}' already has the correct name. Doing nothing.")
+      else
+        self.log('info',"Dryrun: Renaming '#{@filename}' to '#{get_filename(newFilename)}'.")
+      end
+    elsif @filename == filetarget # Do nothing when name is already correct.
+      self.log('info',"File '#{@filename}' already has the correct name. Doing nothing.")
+    else
+      self.log('info',"Renaming '#{@filename}' to '#{filetarget}'.")
+      command     = command + " '#{@filename}' #{filetarget} 2>/dev/null"
+      system(command)
+      if !$?.exitstatus
+        log('error', "Error renaming '#{@filename}' to '#{filetarget}'.")
+        abort
+      else
+        log('info', "Successfully renamed file to '#{filetarget}'.")
+      end
+
+    end
+  end
+
+  #
+  # Return the filename from the available filedata
+  def get_filename(filedata = {})
+
+    if filedata.size > 0
+
+      # Create the filename out of all with some exceptions
+      #
+      # If the doctype is the default one, the first keywords are the
+      # title and the subject
+      if filedata[:doctype] == @defaultDoctype
+
+        # The subject and title is part of the keywords and handled there.
+        filedata[:outputdir] + '/' +
+          filedata[:date] + '-' +
+          filedata[:author] + '-' +
+          filedata[:doctype] + '-' +
+          filedata[:keywords] + '.' +
+          filedata[:extension]
+      else
+        filedata[:outputdir] + '/' + filedata.except(:extension, :title, :subject, :outputdir).values.join('-') + '.' + filedata[:extension]
+      end
+
+    else
+
+      false
+
+    end
+
+  end
+
+  # Validate the output directory
+  def get_outputdir(outputdir = '')
+
+    if !outputdir # outputdir is set to false, assume pwd
+      self.log('debug','No outputdir specified. Taking current pwd of file.')
+      outputdir = File.dirname(@filename)
+    elsif outputdir and !File.exist?(outputdir)
+      puts "Error: output directory '#{outputdir}' not found. Abort."
+      self.log('error',"Output directory '#{outputdir}' not accessible. Abort.")
+      exit 1
+    elsif outputdir and File.exist?(outputdir)
+      outputdir
+    else
+      false
+    end
+
+  end
+
+  # Get the keywords
+  def get_keywords(preface = '')
+
+    if !@@metadata['keywords'].empty?
+
+      keywordsarray = @@metadata['keywords'].split(',')
+      # Replace leading spaces and strings from the keymappings
+      # if the value is identical it will be placed at the beginning
+      # of the array (and therefore be right after the preface in the filename)
+      keywordsarraySorted = Array.new
+      keywordsarray.each_with_index do |value,index|
+        value = value.lstrip.chomp
+
+        @@keymapping.each do |abbreviation,keyvaluearray|
+          if keyvaluearray.kind_of?(String)
+            keyvaluearray = keyvaluearray.split(',')
+          end
+          keyvaluearray = keyvaluearray.sort_by{|size| -size.length}
+          keyvaluearray.each do |keystring|
+            value = value.gsub(/#{keystring.lstrip.chomp}\s?/i, abbreviation.to_s)
+          end
+        end
+
+        # Remove special characters from string
+        keywordsarray[index] = value.gsub(/\s|\/|\-|\./,'_')
+
+        # If the current value matches some of the replacement abbreviations,
+        # put the value at index 0 in the array. It will then be listed earlier in the filename.
+        if value.match(/^#{@@keymapping.keys.join('|')} /i)
+          keywordsarraySorted.insert(0, keywordsarray[index])
+        else
+          keywordsarraySorted.push(keywordsarray[index])
+        end
+
+      end
+
+      # Insert the preface if it is not empty
+      if !preface.to_s.empty?
+        keywordsarraySorted.insert(0, preface)
+      end
+
+      # Convert the keywordarray to a string an limit the number
+      # of keywords according to @nrkeywords or the parameter 'all'
+      if @@metadata['keywords'] = !@allkeywords
+        keywords = keywordsarraySorted.values_at(*(0..@nrkeywords-1)).join('-')
+      else
+        keywords = keywordsarraySorted.join('-')
+      end
+
+      # Normalize all keywords and return value
+      I18n.enforce_available_locales = false
+      I18n.transliterate(keywords).downcase.chomp('-')
+
+    else # Keywords metafield is empty :(
+      # So we return nothing or the preface (if available)
+
+      !preface.empty? ? preface : ''
+
+    end
+
+  end
+
+
+
+  # Get the preface for the keywords
+  # If the title is meaningful, then the
+  # subject will become the preface ( = first keyword)
+  # If the subject matches number/character combination and contains no spaces,
+  # the preface will be combined with the doctype.
+  # If not: The preface will contain the whole subject with dots and spaces being
+  # replaced with underscores.
+  def get_keywordsPreface(filedata = {})
+
+    I18n.enforce_available_locales = false
+    if filedata[:doctype].nil? or filedata[:doctype].empty?
+      filedata[:doctype] = @defaultDoctype
+    end
+
+    if !filedata[:subject].nil? and !filedata[:subject].empty? and
+      !filedata[:doctype] == @defaultDoctype
+
+      I18n.transliterate(filedata[:subject])
+
+    else
+
+      # Document matches standard document type.
+      # title and subject are being returned.
+
+      # Normalize special characters
+      title   = @@metadata['title'].downcase
+      subject = !filedata[:subject].empty? ? '_' + filedata[:subject].downcase : ''
+      subject = subject.gsub(/\s|\-|\&/, '_')
+      I18n.transliterate(title + subject)
+
+    end
+
+  end
+
+  # Get the doctype from the title
+  #
+  def get_doctype()
+    doctype = @defaultDoctype
+    @@keymapping.each do |key,value|
+      value.kind_of?(String) ? value = value.split : ''
+      value.each do |keyword|
+        @@metadata['title'].match(/#{keyword}/i) ? doctype = key : ''
+      end
+    end
+    doctype.downcase
+  end
+
+  # Get the author from the metatags and
+  # normalize the string
+  def get_author()
+    author = @@metadata['author'].gsub(/\./,'_').gsub(/\&/,'').gsub(/\-/,'').gsub(/\s|\//,'_').gsub(/\,/,'_').gsub(/\_\_/,'_')
+    I18n.enforce_available_locales = false
+    I18n.transliterate(author).downcase # Normalising
+  end
+
+end

data/lib/pdfmd/pdfmdshow.rb

@@ -0,0 +1,88 @@
+# == Class: pdfmd.show
+#
+class Pdfmdshow < Pdfmd
+  attr_accessor :filename
+
+  @@show_filename = false 
+  @@outputformat  = ''
+  @@default_tags  = ['createdate', 'author', 'title', 'subject', 'keywords']
+
+  def initialize(filename)
+    super(filename)
+    @filename = filename
+  end
+
+
+  # Define if the filename should be visible in the output
+  def show_filename( enable = nil)
+    @@show_filename = enable ? true : false
+  end
+
+
+  # Define the output format for showing the metadata
+  def set_outputformat( format = 'yaml' )
+    format.nil? ? format = 'yaml' : ''
+    self.log('debug',"Output format set to '#{format}'.")
+    @@outputformat = format
+  end
+
+  # Overvwrite the tags
+  def set_tags( tags = @@default_tags)
+
+    if tags
+
+      # Tags can be specified as array or string
+      #
+      case tags.class.to_s
+      when /array/i
+        @@default_tags = tags
+      when /string/i
+        @@default_tags = tags.split(/,\s+/)
+      end
+
+    end
+
+  end
+
+  # Return the provided metatags
+  def show_metatags( tags = @@default_tags, format = @@outputformat, show_filename = @@show_filename )
+
+    # Build the output hash from the tags matching the values in @@default_tags
+    metadataOutputHash = Hash.new
+    tags.each do |tagname|
+      if @@metadata.has_key?(tagname)
+        metadataOutputHash[tagname] = @@metadata[tagname]
+      elsif tagname.downcase == 'all' # Exception when for keyword 'all'
+        metadataOutputHash = @@metadata
+      end
+    end
+
+    if show_filename
+      metadataOutputHash['filename'] = @filename
+    end
+
+    # Return output well formatted
+    case format
+    when /hash/i
+      self.log('info',"Showing metatags for '#{@filename}' in format 'hash'.")
+      metadataOutputHash
+    when /csv/i
+      csvData = Hash.new
+      metadataOutputHash.keys.each do |tagname|
+        csvData[tagname] = '"' + metadataOutputHash[tagname.downcase].to_s.gsub(/"/,'""') + '"'
+      end
+      self.log('info',"Showing metatags for '#{@filename}' in format 'csv'.")
+      csvData.values.join(',')
+    when /json/i
+      require 'json'
+      self.log('info',"Showing metatags for '#{@filename}' in format 'json'.")
+      metadataOutputHash.to_json
+    else 
+      require 'yaml'
+      self.log('info',"Showing metatags for '#{@filename}' in format 'yaml'.")
+      metadataOutputHash.to_yaml
+    end
+
+  end
+
+end