cremefraiche 1.1.8

data/lib/gui/HowtoDialog.rb

@@ -0,0 +1,183 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   ©2012-2016, Michael Uplawski <michael.uplawski@uplawski.eu>           *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 3 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   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.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+=end
+require 'gtk3'
+require_relative '../cremefraiche'
+require_relative 'ButtonLabel'
+require_relative '../translating'
+require_relative '../file_checking'
+require_relative '../basic_logging'
+
+
+class HowtoDialog
+	include Translating
+	include BasicLogging
+	@@GD = File::expand_path(File::dirname(__FILE__) ) + File::Separator if !defined?(@@GD)
+	@@HOWTO = $PROG_DIR.dup << '../doc/gui_howto.pdf'
+	PDFViers = %w"firefox opera epiphany-browser"
+
+	def initialize(options = {})
+		@hdialog = Gtk::Dialog.new()
+		reader_frame = Gtk::Frame.new(trl('Howto'))
+
+		reader_vbox = Gtk::Box.new(:vertical, 5)
+		reader_vbox.border_width = 5
+		reader_hbox = Gtk::Box.new(:horizontal, 5)
+		reader_hbox.border_width = 5
+
+		bl_text = trl("Please name the command which starts your PDF viewer (e.g. qpdfview, acroread, evince, display ...).")
+		reader_label = Gtk::Label.new(bl_text)
+		reader_label.wrap = true
+		@reader_entry = Gtk::Entry.new                                 
+		@reader_entry.width_chars = 33
+		@reader_entry.height_request = 25
+		# Sabotage fix. “We, the Gods of GTK approve of this failure”
+		# @reader_entry.text = $CONF.pdf_reader
+		@reader_entry.text = find_reader()
+		@bc_button = Gtk::Button.new()
+		@bc_button.add(ButtonLabel.new(trl('_Choose'), "%s/gtk-open.xpm" %@@GD))
+
+		reader_vbox.pack_start(reader_label, :expand => false)
+
+		reader_hbox.pack_start(@reader_entry, :expand => false)
+		reader_hbox.pack_start(@bc_button, :expand => false)
+		reader_vbox.pack_start(reader_hbox, :expand => false)
+		reader_frame.add(reader_vbox)
+
+		button_box = Gtk::ButtonBox.new(:horizontal)
+		button_box.layout_style = :start
+		@cancel_button = Gtk::Button.new()
+		@cancel_button.add(ButtonLabel.new(trl('_Cancel'), "%s/gtk-stop.xpm" %@@GD))
+		@ok_button = Gtk::Button.new()
+		@ok_button.add(ButtonLabel.new(trl('_Accept'), "%s/gtk-execute.xpm" %@@GD))
+
+		button_box.pack_start(@ok_button, :expand => false)
+		button_box.pack_start(@cancel_button, :expand => false)
+
+		@hdialog.child.pack_start(reader_frame)
+		@hdialog.child.pack_start(button_box)
+
+		@bc_button.set_tooltip_text trl('Choose a PDF viewer')
+		@reader_entry.set_tooltip_text trl('Command, which starts your PDF viewer')
+		@cancel_button.set_tooltip_text trl('Close dialog')
+		@ok_button.set_tooltip_text trl('Executes your PDF-viewer and shows the Howto manual')
+
+		connect_buttons
+		@hdialog.set_title('HOWTO: ' << CremeFraiche::prog_info[:app_name])
+		@hdialog.child.show_all
+		@hdialog.signal_connect('response') do |dlg, resp|
+			debug("response %i emitted" %resp) 
+			@adialog.destroy if(:cancel == resp) 
+		end  
+		if(options && options.keys.include?(:on_destroy))
+			@hdialog.signal_connect('destroy') {options[:on_destroy].call() }
+		end
+
+		@hdialog.show
+	end
+
+	def find_reader
+		PDFViers.detect(''){|c| $Progs.include?(c)}
+	end
+
+	def choose_reader
+		dialog = Gtk::FileChooserDialog.new(:title => trl("set reader"),
+						    :parent => nil,
+						    :action => :open,
+						    :buttons => [[:cancel, :cancel], [:accept, :accept]])
+
+		if(@reader_entry.text && ! @reader_entry.text.empty?)
+			debug('reader is ' << @reader_entry.text)
+			dialog.filename = @reader_entry.text 
+		end
+		ret = dialog.run
+		br = (ret == Gtk::ResponseType::ACCEPT ? dialog.filename : nil)
+		dialog.destroy
+
+		msg = File_Checking.file_check(br, [:exist?, :file?, :executable?]) if br   
+		if(msg)
+			error(msg) 
+			msg_dialog(msg, DLG_ERROR) 
+			br = nil
+		end
+		return br
+	end
+
+	def connect_buttons
+		@bc_button.signal_connect("clicked") do 
+			br = choose_reader
+			@reader_entry.text = br if br
+		end
+
+		@cancel_button.signal_connect("clicked") do
+			@hdialog.destroy
+		end
+		@ok_button.signal_connect("clicked") do
+			run_reader(@reader_entry.text) if @reader_entry.text
+		end
+	end
+
+	def run_reader(br)
+		msg = nil
+		if(br && ! br.empty?)
+			begin
+				fork_sym = (RUBY_PLATFORM =~ /win/) ? '' : ' &'
+				exec_command = "%s %s%s" %[br, @@HOWTO, fork_sym]
+				debug "exec-command will be %s" %exec_command 
+				hr = system exec_command
+				if(!hr)
+					msg = trl("Cannot open the PDF viewer!", "\n") 
+					msg += trl("Please verify, that %s is correctly spelled or use another reader.", "\"#{br}\"") 
+				else
+					@hdialog.destroy
+				end
+			rescue Exception => ex
+				msg = trl("Cannot open the PDF viewer %s", ex)
+			end
+		else
+			msg = trl('No reader selected, skipping Howto.')
+		end
+		error(msg) if msg
+		debug($?.to_s) if @log
+		msg_dialog(msg, DLG_ERROR) if msg
+	end
+
+	def msg_dialog(msg, type)
+		dialog = Gtk::MessageDialog.new(
+						:parent => nil, 
+						:flags => :destroy_with_parent,
+						:type => type,
+						:message => "%s: \"%s\"" %[Translating::trl(type.to_s.upcase), msg])
+
+		dialog.set_title(DLG_INFO == type ? 'Info' : 'Error' )
+		dialog.run
+		dialog.destroy
+		return msg
+	end
+
+
+end
+
+# execute if this script is the argument to the ruby-interpreter.
+if __FILE__ == $0
+	HowtoDialog.new()
+end
+

data/lib/gui/conf_option.rb

@@ -0,0 +1,274 @@
+#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'
+require_relative '../translating'
+require_relative 'message_dialog'
+require_relative 'conf_value'
+
+require 'ostruct'
+
+=begin
+        An object of this class represents a configuration-option.
+        It comprises the name, the value, the default-value, the data-type and the 
+        documentation of such an option.
+=end
+
+class ConfOption
+  include Translating
+  include BasicLogging
+
+  @@Doc = {
+    :pdf_prefix => Translating::trl( "The PDF-prefix and -suffix are added to the name of an eml-file to create the name of a resulting PDF-file, potentially keeping a numerical prefix intact, like in prefix_[num_]eml_suffix.pdf, e.g. mail_3_eml_arch.pdf."),
+
+    :pdf_suffix =>  Translating::trl("The PDF-prefix and -suffix are added to the name of an eml-file to create the name of a resulting PDF-file, potentially keeping a numerical prefix intact, like in prefix_[num_]eml_suffix.pdf, e.g. mail_3_eml_arch.pdf."),
+
+    :log_level => Translating::trl("The log-level can be fatal, error, warn, info or debug.") << ' ' << Translating::trl('Restart the program for changes to this option to take effect.'),
+
+    :log_file => Translating::trl("Path to the protocol-file, where the logger-output will be directed, if configured. When left empty, stdout will be used."),
+
+    :page_size => Translating::trl("Page size, e.g. A4"),
+
+    :page_layout => Translating::trl("Page layout, one of portrait or landscape"),
+
+    :regular_font => Translating::trl("Font-file to use in the PDF-file. By default, the fonts used in the PDF are those supported by the Ruby-gem \"Prawn\", i.e. Courier, Times-Roman and Helvetica or the respective replacement font, which is valid on your system. The font-file, that you name here, will replace Helvetica and be used for the headers and the body of the email in PDF-format. ATTN! For your font-settings to take effect, you must name ALL four font-files!"),
+
+    :bold_font => Translating::trl("Font-file to use in the PDF-file. By default, the fonts used in the PDF are those supported by the Ruby-gem \"Prawn\", i.e. Courier, Times-Roman and Helvetica or the respective replacement font, which is valid on your system. The font-file, that you name here, will replace Helvetica and be used for the headers and the body of the email in PDF-format. ATTN! For your font-settings to take effect, you must name ALL four font-files!"),
+
+    :italic_font => Translating::trl("Font-file to use in the PDF-file. By default, the fonts used in the PDF are those supported by the Ruby-gem \"Prawn\", i.e. Courier, Times-Roman and Helvetica or the respective replacement font, which is valid on your system. The font-file, that you name here, will replace Helvetica and be used for the headers and the body of the email in PDF-format. ATTN! For your font-settings to take effect, you must name ALL four font-files!"),
+
+    :bold_italic_font => Translating::trl("Font-file to use in the PDF-file. By default, the fonts used in the PDF are those supported by the Ruby-gem \"Prawn\", i.e. Courier, Times-Roman and Helvetica or the respective replacement font, which is valid on your system. The font-file, that you name here, will replace Helvetica and be used for the headers and the body of the email in PDF-format. ATTN! For your font-settings to take effect, you must name ALL four font-files!"),
+
+    :visible_headers => Translating::trl("The visible headers will be shown in the final pdf. Headers which are noted here *and* also under hidden headers, will anyway be honored (*not* ignored)."), 
+
+    :hidden_headers => Translating::trl("The hidden headers will be suppressed... they are still here for reference. Add more, as you stumble over new headers in your e-mail. Headers which are noted here *and* also under visible headers will anyway be honored (*not* ignored)."),
+
+    :show_content_type => Translating::trl("This option controls wether a visible body-part is preceded by a line indicating the content-type, like \"text/plain; charset=ISO-8859-1; format=flowed\""),
+
+    :content_type_color => Translating::trl("The color of the content-type"),
+
+    :replacement_color => Translating::trl("This is the color of a replacement-character, where a character cannot be converted to UTF-8."),
+
+    :replacement_char => Translating::trl("Symbols which will replace any character which cannot be converted to UTF-8."),
+
+    :link_color => Translating::trl("Color for hyper-links"),
+
+    :author => Translating::trl("Provided the pdftk-tool is installed and can be found in the environment path, the value of these variables will set the respective field in the meta-data of the resulting PDF-files. Leave empty to ignore..."),
+
+    :subject => Translating::trl("Provided the pdftk-tool is installed and can be found in the environment path, the value of these variables will set the respective field in the meta-data of the resulting PDF-files. Leave empty to ignore... Default subject is the subject-line of the original mail."),
+
+    :keywords => Translating::trl("Provided the pdftk-tool is installed and can be found in the environment path, the value of these variables will set the respective field in the meta-data of the resulting PDF-files. Leave empty to ignore..."),
+
+    :title => Translating::trl("Provided the pdftk-tool is installed and can be found in the environment path, the value of these variables will set the respective field in the meta-data of the resulting PDF-files. Leave empty to ignore..."),
+
+    :save_attachments => Translating::trl("If and where attachments shall be placed. Either 'pdf' to store files in the PDF (needs pdftk) or a directory path to store files in the given directory. A link to the file shall be provided in the PDF. The directory MUST EXIST, or 'false' to ignore the attachments"),
+
+    :attachment_link_color => Translating::trl("The color of the links to saved attachments, if \"save attachments\" is set to a file path, rather than 'pdf'"),
+
+    :pdf_reader => Translating::trl("A reader-application which can be used in different contexts to show a PDF-file."),
+  }
+
+  @@Default = {
+    :pdf_prefix => '',
+    :pdf_suffix => '',
+    :log_level => 'unknown',	
+    :log_file => STDOUT,
+    :page_size => 'A4',
+    :page_layout => 'portrait',
+    :regular_font => '',	
+    :bold_font => '',
+    :italic_font => '',
+    :bold_italic_font => '',
+    :visible_headers => 'All mail-headers',
+    :hidden_headers => '',
+    :show_content_type => false,
+    :content_type_color => '000080',
+    :replacement_color => 'f08080',
+    :replacement_char => '<?>',
+    :link_color => '700000',
+    :author => '',
+    :subject => 'mail-subject',
+    :keywords => '',
+    :title => '',
+    :save_attachments => 'pdf',
+    :attachment_link_color => '008000',
+    :pdf_reader => ''
+  }
+
+  @@Types = {
+    :pdf_prefix => :string,
+    :pdf_suffix => :string,
+    :log_level => :choose_text,	
+    :log_file => :file,
+    :page_size => :choose_text,
+    :page_layout => :choose_text,
+    :regular_font => :font,	
+    :bold_font => :font,
+    :italic_font => :font,
+    :bold_italic_font => :font,
+    :visible_headers => :stringlist,
+    :hidden_headers => :stringlist,
+    :show_content_type => :bool,
+    :content_type_color => :hexcolor,
+    :replacement_color => :hexcolor,
+    :replacement_char => :string,
+    :link_color => :hexcolor,
+    :author => :string,
+    :subject => :string,
+    :keywords => :string,
+    :title => :string,
+    :save_attachments => :choose_text,
+    :attachment_link_color => :hexcolor,
+    :pdf_reader => :file
+  }
+=begin UNUSED
+        @@Pane_content = {
+                :show_content_type => :bool,
+                :regular_font => :file,	
+                :bold_font => :file,
+                :italic_font => :file,
+                :bold_italic_font => :file,
+                :attachment_link_color => :hexcolor,
+                :visible_headers => :stringlist,
+                :hidden_headers => :stringlist,
+                :save_attachments => :choose_text,
+                :content_type_color => :hexcolor,
+                :replacement_color => :hexcolor,
+                :replacement_char => :string,
+                :link_color => :hexcolor,
+
+        }
+        @@Pane_pdf = {
+                :pdf_prefix => :string,
+                :pdf_suffix => :string,
+                :page_size => :choose_text,
+                :page_layout => :choose_text,
+                :author => :string,
+                :subject => :string,
+                :keywords => :string,
+                :title => :string,
+        }
+        @@Pane_program = {
+                :log_level => :choose_text,	
+                :log_file => :file,
+                :pdf_reader => :file
+        }
+=end	
+  @@Choices = {
+    :log_level => [:unknown, :debug, :info, :error, :fatal, :warn],
+    :page_size => %w"4A0 2A0 A0 A1 A2 A3 A4 A5 A6 A7 A8 A9 A10 B0 B1 B2 B3 B4 B5 B6 B7 B8 B9 B10 C0 C1 C2 C3 C4 C5 C6 C7 C8 C9 C10 RA0 RA1 RA2 RA3 RA4 SRA0 SRA1 SRA3 SRA4 EXECUTIVE FOLIO LEGAL LETTER".collect{|ps| ps.to_sym},
+    :page_layout => [:portrait, :landscape],
+    :save_attachments => [:pdf, :path, :false]
+  }
+
+  @@Constraints = {
+    :pdf_reader => [:exist, :file, :executable],
+    :save_attachments => [:exist, :directory, :writable],
+    :bold_font => [:exist, :file, :readable],
+    :italic_font => [:exist, :file, :readable],
+    :bold_italic_font => [:exist, :file, :readable],
+    :regular_font => [:exist, :file, :readable],
+  }
+
+  class Error < RuntimeError
+  end
+  class InvalidOptionError < Error
+  end
+  class NoValueError < Error
+  end
+
+  def initialize(name, value = nil)
+    keys = @@Types.keys
+    nkey = name.downcase.gsub(' ', '_').to_sym	
+    @name = name
+    if(keys.include?(nkey))
+      debug("configuring " << nkey.to_s << ", value is " << value.to_s)
+
+      @display_name = trl(name)
+      @otype = @@Types[nkey]
+      debug('set otype ' << @otype.to_s)
+
+      @choices = @@Choices[nkey] if @@Choices.keys.include?(nkey)
+      @doc = @@Doc[nkey]
+      @default = @@Default[nkey]
+      @constraints = @@Constraints[nkey]
+      begin
+        if(!@constraints && @choices && !@choices.include?(value ? value.to_sym : ''.to_sym) )
+          message = trl("Value %s is not permitted for option %s!") %[(value && !value.empty? ? trl(value.to_s) : '(empty)') , name]
+          message << "\nSetting default-value %s" %(@default.to_s )
+          warn(message)
+          msg_dialog(message, 'warning' )
+
+          @value = ConfValue.new(@name, @default)
+        else
+          @value = ConfValue.new(@name, value)
+        end
+      rescue Exception => ex
+        error('Error in configuration-option ' << @name << ': ' << ex.message)
+      end
+
+    else
+      @doc = 'N I L'
+      @default = 'N I L'
+      msg = trl("Unknown configuration-option %s!") %name
+      error(msg)
+      raise InvalidOptionError, "An option \"" << name << "\" does not exist!" ;
+    end
+    debug "Option #{name} is initialized"
+  end
+
+  attr_reader :name, :display_name, :type, :default, :choices, :constraints
+
+  def to_s
+    self.class.name.dup << ': name = ' << @name << ', value = ' << (@value ? @value.to_s : 'N I L') << ', default = ' << @default.to_s << ', doc = ' << @doc 
+  end
+
+  def value=(value)
+    if @value
+      @value.value = value
+    else
+      @value = ConfValue.new(value)
+    end
+  end
+
+  def value
+    if (@otype != :bool && !@value)
+      msg = trl("No value has been set for option %s.") %(@name) 
+      warn(msg)
+      nil
+    elsif @value
+      @value.value
+    else
+      nil
+    end
+  end
+
+  def type
+   @otype
+  end
+
+  def display_value
+    @value.display_value
+  end
+
+  def doc
+    if !@doc
+      error(trl("Option %s is missing a documentation.") %(@name) )
+    else
+      @doc
+    end
+  end
+end
+

data/lib/gui/conf_value.rb

@@ -0,0 +1,58 @@
+#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
+# An object of this type represents the value of a configuration-option in case
+# that it needs to be translated for display in the GUI, but not for the
+# persistent configuration.
+#
+# Not every value needs to be encapsulated in a ConfValue object. Test, if there
+# is a translation to read with value.respond_to?(:display_value). In case that a 
+# translation exists, persist obj.value. Otherwise show and persist the value
+# as is. 
+# Examples: 'A4', 'A5', 'letter' will not be translated, but used and displayed
+# in the same way, as 'A4', 'A5' or 'letter'. You do not need a ConfValue in that 
+# case.
+#
+# 'landscape' and 'portrait' in contrast may be displayed as 'paysage' and
+# 'portrait' in French, 'Hochformat' and 'Querformat' in the German locale, while
+# the configuration file will only contain 'landscape' or 'portrait'.
+#
+# See conf_option.rb for actual uses.
+
+require_relative '../translating'
+
+class ConfValue
+  include Translating
+  def initialize(label, value)
+    @label = label
+    @value = value
+    @value ||= ''
+    if(value.respond_to?(:to_ary) )
+      @display_value = @value.map{|v| trl(v) }
+    else
+      @display_value = trl(value.to_s, false)
+    end
+  end
+  def to_s
+    self.class.name.dup << ': value = ' << @value.to_s << ', display_value = ' << @display_value.to_s
+  end
+
+  attr_accessor :value
+  attr_reader :display_value
+
+end
+
+# EOF
+