cremefraiche 1.1.8

data/lib/emlfile.rb

@@ -0,0 +1,136 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2011-2023, Michael Uplawski <michael.uplawski@uplawski.eu>           *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the WTFPL 2.0 or later version of the  LICENSE. *
+ *   See https://wtfpl2.com/ for details.                                  * 
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
+ *                                                                         *
+ ***************************************************************************/
+=end
+
+require_relative "file_checking"
+require_relative "translating"
+require_relative "basic_logging"
+require 'mail'
+
+# A representation of an EML-file.
+# Wraps the Mail-object (from the Mail-gem).
+class EmlFile
+  include BasicLogging
+
+  BasicLogging::mute(self)
+  include File_Checking
+  include Translating
+  @@MAIL_INTRO = "From "
+  @@errors = []
+  attr_reader :headers, :body, :files, :filename, :msg
+
+  public
+
+  # create the representation of 1 eml-file
+  def initialize(filename)
+    debug 'EMLFile - is ' << inspect
+    debug('log initialized')
+    @attachments = nil
+    @body = nil
+    @headers = nil
+    msg = file_check(filename, :exist, :file, :readable)
+    debug('file checked: ' << msg.to_s)
+    @@errors << msg if msg
+    # split the file into many, one for each e-mail
+    if(!msg)
+      split(filename)
+    else
+      error(trl("Invalid file") << ": %s (%s)" %[filename,msg] )
+
+    end
+  end
+  # delegate messages, that this object cannot respond to to the Mail-object
+  def method_missing(method, *args)
+    if(@mail.respond_to?(method) )
+      @mail.send(method, *args)
+    else
+      error(trl("method %s is undefined for objects of class %s") %[method, self.class.name])
+    end
+  end
+  # call the given block on each individual mail-file
+  def mails(&b)
+    if(@files)
+      debug('working on the files: ' << @files.join(', '))
+      @files.each do |f|
+        parse(f)
+        @filename=f
+        yield(self)
+      end
+    end
+  end
+
+  private
+
+  # separate the components of each mail-file
+  def parse(filename)
+    if(filename)
+      @mail = Mail.read(filename)
+      if(@mail )
+        @headers = @mail.header_fields
+        # debug('Parsed headers are ' << @headers.join(', ') )
+        @body = @mail.body
+        # debug('Parsed body is ' << @body.to_s )
+        @attachments = @mail.attachments if @mail.attachment?
+      end
+    end
+  end
+
+  # prefix the number num with a maximum of count_zero zeros
+  def prefix_number(num, count_zero = 2)
+    str = ''
+    if(num)
+      str = num.to_s  
+      count_zero.times do
+        if(num % 10 == num)
+          str = ('0' << str )
+          debug('str is now ' << str)
+        end
+      end	
+    end
+    return str
+  end
+
+  # split the file 'filename' into separate files, each containing 1 mail
+  def split(filename)
+    dir = $CONF.temp_dir
+    debug(trl("storing temporary files in %s") %dir.path)
+    index = 0
+    @files = []
+    begin
+      File.open(filename, 'r') do |ifl|
+        ofl = nil
+        ifl.each_line do |line|
+          if(line.start_with?(@@MAIL_INTRO))	
+            ofl.close if ofl && !ofl.closed?
+            index += 1
+            ofl_name = format("%s/%s_%s" %[dir.path, prefix_number(index, 2), File.basename(filename)])
+            debug(trl("storing a message in %s") %ofl_name) 
+            ofl = File.open(ofl_name, 'w')
+            @files << ofl_name
+          end
+          ofl << line if ofl && !ofl.closed? 
+        end
+        ofl.close if ofl && !ofl.closed?
+      end
+    rescue Exception => ex
+      error(trl("Cannot open file '%s'") %filename << ': ' <<  ex.message )
+    end
+    # a single e-mail can be stored in its own file
+    if(@files.empty? && File::exist?(filename) && File::readable?(filename) )
+      @files << filename  
+    end
+  end # END split()
+end # END of class
+

data/lib/file_checking.rb

@@ -0,0 +1,82 @@
+#encoding: UTF-8
+
+=begin
+/***************************************************************************
+ *   ©2023-2023, Michael Uplawski <michael.uplawski@uplawski.eu>           *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the WTFPL 2.0 or later version of the  LICENSE. *
+ *   See https://wtfpl2.com/ for details.                                  * 
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
+ *                                                                         *
+ ***************************************************************************/
+=end
+
+=begin
+A module to facilitate frequently occuring checks on
+file-system objects
+=end
+module File_Checking
+
+  @@text_messages  = {
+        :exist? => "does not exist!",
+        :exist => "does not exist!",
+        :readable? => "is not readable!",
+        :readable => "is not readable!",
+        :executable? => "is not executable!",
+        :executable => "is not executable!",
+        :writable? => "is not writable!",
+        :writable => "is not writable!",
+        :directory? => "is not a directory!",
+        :directory => "is not a directory!",
+        :file? => "is not a file!",
+        :file => "is not a file!",
+      }
+
+      # Checks if the file with the name from the first
+      # parameter has the properties, listed in the second. 
+      # The messages parameter is an array of one or several
+      # of :exist?, :readable?, :writable?, :directory?  or 
+      # their string-representations, respectively. 
+      # Returns nil in case of success, otherwise an 
+      # informative message, describing the first negative
+      # test-result.
+      def file_check(file, *messages)
+        File_Checking.file_check(file, *messages)
+      end
+     
+      # Checks if the file with the name from the first
+      # parameter has the properties, listed in the second. 
+      # The messages parameter is an array of one or all
+      # of :exist?, :readable?, :writable?, :directory? or
+      # their string-representations, respectively. 
+      # Returns nil in case of success, otherwise an 
+      # informative message, describing the first negative
+      # test-result.
+      def self.file_check(file, *messages)
+        msg = nil
+	if(file && messages.respond_to?(:to_ary) && !messages.empty?)
+		messages.each do |k|
+			if(! k.to_s.end_with?('?'))	
+				k = (k.to_s << '?').to_sym
+			end
+			@log.debug ('checking ' << k.to_s) if @log
+			if(msg == nil && File.respond_to?(k) && ! File.send(k, file.to_s))
+				msg = "#{file} #{@@text_messages[k.to_sym]}"
+			end
+		end
+	end
+	msg
+      end
+end
+
+=begin
+# example
+
+include File_Checking
+msg = file_check('some_file.txt', [:exist?, :readable?, 'writable'])
+puts msg if msg
+=end

data/lib/gui/AboutDialog.rb

@@ -0,0 +1,63 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2011-2023, Michael Uplawski <michael.uplawski@uplawski.eu>           *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the WTFPL 2.0 or later version of the  LICENSE. *
+ *   See https://wtfpl2.com/ for details.                                  * 
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
+ *                                                                         *
+ ***************************************************************************/
+=end
+require 'gtk3'
+require_relative '../cremefraiche'
+require_relative '../translating'
+require_relative '../file_checking'
+require_relative '../license.rb'
+require_relative '../basic_logging.rb'
+
+GD = File::expand_path(File::dirname(__FILE__) ) + File::Separator if !defined?(GD)
+
+class AboutDialog
+  include Translating
+  include BasicLogging
+
+  @@prog_info = CremeFraiche::prog_info
+  # prevent repeated appending of the comments 
+  @@info = Translating::trl('running with Ruby') << ' ' << RUBY_VERSION << ' (' << RUBY_RELEASE_DATE << ') ' 
+  @@info << RUBY_PLATFORM << "\n\n" << Translating::trl('Current system') << ': ' << @@prog_info[:cur_system]
+
+  @@License_File = GD.dup << '../doc/license.txt'
+
+    # FED UP WITH GTK !!
+  CLS = -4
+  def initialize( options = {})
+
+    @adialog = Gtk::AboutDialog.new 
+    @adialog.name = @@prog_info[:app_name]
+    @adialog.title = @@prog_info[:app_name]
+    @adialog.set_program_name @@prog_info[:app_name]
+    @adialog.version = @@prog_info[:version]
+    @adialog.copyright = "© #{@@prog_info[:years]} #{@@prog_info[:author]} #{@@prog_info[:author_mail]}"
+    @adialog.website = "#{@@prog_info[:web_page]}"
+
+    @adialog.comments = @@info
+    @adialog.license = LICENSE_TEXT
+    @adialog.logo = GdkPixbuf::Pixbuf.new(:file => GD + "icon.xpm")
+    @adialog.signal_connect('response') do |dlg, resp|
+      debug("response %i emitted" %resp)
+      # I am fed up with the Gtk docuentation
+      @adialog.close if(CLS == resp) 
+    end  
+    if(options && options.keys.include?(:on_destroy))
+      @adialog.signal_connect('destroy') {options[:on_destroy].call() }
+    end
+    @adialog.show
+  end
+
+end
+

data/lib/gui/ButtonLabel.rb

@@ -0,0 +1,41 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2011-2023, Michael Uplawski <michael.uplawski@uplawski.eu>           *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the WTFPL 2.0 or later version of the  LICENSE. *
+ *   See https://wtfpl2.com/ for details.                                  * 
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.                  *
+ *                                                                         *
+ ***************************************************************************/
+=end
+require_relative '../basic_logging.rb'
+require 'gtk3'
+require_relative '../translating'
+
+=begin
+  Meant to be used as label for push-buttons,
+  objects of this class combine a text-value
+  with a user-provided icon.
+=end
+class ButtonLabel < Gtk::Box
+	include BasicLogging
+	def initialize(text, imagefile = nil)
+		super(:horizontal, 5)
+		set_border_width(0)
+		pack_start(Gtk::Image.new(:file => imagefile)) if imagefile
+		@mlabel = Gtk::Label.new( text, :mnemonic => true)
+		@mlabel.markup_with_mnemonic=text
+		# debug(@mlabel.mnemonic_keyval)
+		pack_start(@mlabel) 
+	end
+
+	def mnemonic_widget=(wd)
+		@mlabel.mnemonic_widget=(wd)
+	end
+
+end