flnews_post_proc 1.94 → 1.97

data/lib/bak_basic_logging.rb

@@ -0,0 +1,202 @@
+#!/bin/env ruby
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   2023-2025, 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, see                     * 
+ *   http://www.wtfpl.net/about/                                           *
+ *                                                                         *
+ *   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
+
+#
+# Simplified logging. 
+# See example code at the bottom of this file.
+# Execute this file to see the output.
+module BasicLogging
+
+  DEBUG = 0
+  INFO =  1
+  WARN =  2
+  ERROR = 3
+  FATAL = 4
+  UNKNOWN = nil
+  
+  # this is mainly for the translation of method calls into log levels
+  Levels = {:debug => DEBUG, :info => INFO, :warn => WARN, :error => ERROR,
+            :fatal => FATAL, :unknown => UNKNOWN}
+
+  @@log_level = UNKNOWN
+  @@target = STDOUT
+  @@muted = []
+
+  # do not log, if caller is obj (class or instance)
+  def self.mute(obj)
+    name = obj.class == Class ? obj.name.dup : obj.class.name
+    @@muted << name
+  end
+
+  # return true if obj is muted and will not log.
+  def self.is_muted?(obj)
+    name = obj.class == Class ? obj.name.dup : obj.class.name
+    @@muted.include?(name)  
+  end
+
+  # set the log level 
+  def set_level(lv)
+    if lv.respond_to?(:to_str) && Levels.keys.include?(lv.strip.to_sym)
+      lv = Levels[lv.to_sym]
+    elsif lv.respond_to?(:to_sym) && Levels.keys.include?(lv)
+      lv = Levels[lv]
+    end
+
+    if(!lv || (lv.respond_to?(:to_int) && lv >= DEBUG && lv <= FATAL) )
+      @@log_level = lv
+    else
+      msg = __FILE__.dup << ": ERROR : invalid log level \"" << lv.to_s << "\""
+      msg << "\n" << "Keepinng old log level " << Levels.keys.detect {| k| Levels[k] == @@log_level}.to_s
+      STDERR.puts msg
+      puts msg
+    end
+  end
+
+  # set the log target 
+  def set_target(tg)
+    if tg.respond_to?(:to_io) 
+      @@target = tg
+    elsif(!File::exist?(tg) || ( File.file?(tg) && File.writable?(tg) ) )
+      @@target = File.open(tg, 'w+')  
+    elsif !tg || tg.respond_to?(:to_str) && tg.strip.empty?
+      @@target = nil
+    else
+      STDERR.puts __FILE__.dup << ': ERROR : target ' << tg << ' cannot be set'
+      STDERR.puts "Keeping old target " << @@target.inspect
+      return
+    end
+  end
+
+  # Output log messages, depending on the log level set for the calling class
+  # and the name of the alias method which is actually called.
+  def log(message)
+    if !BasicLogging.is_muted?(self)
+      # how has this method been called?
+      mlevel = __callee__
+      if Levels.has_key?(mlevel) && Levels[mlevel] <=  FATAL
+        # output only for levels equal or above the value that corresponds to
+        # the calling alias.
+        format_log( message, mlevel) if @@log_level && Levels[mlevel] >= @@log_level 
+      else
+        STDERR.puts __FILE__.dup << ": ERROR : invalid log level \"" << mlevel.to_s << "\""
+      end
+    end
+  end
+
+  def target
+    @@target.path if @@target
+  end
+
+  def level
+    @@level.to_s if @@level
+  end
+
+  # Clear the log (-file)
+  def clear_log
+    if @@target && @@target.respond_to?(:truncate)
+      lock_target{ @@target.truncate(0) }
+    end
+  end
+
+  alias :debug :log
+  alias :info :log
+  alias :warn :log
+  alias :error :log
+  alias :fatal :log
+
+  private 
+
+  def lock_target(&block)
+    begin
+      if @@target.respond_to?(:flock) 
+        @@target.flock(File::LOCK_EX)
+        block.call
+        @@target.flock(File::LOCK_UN)
+      elsif @@target.respond_to?(:to_io)
+        block.call
+      end
+    rescue => ex
+      STDERR.puts __FILE__.dup  << ": ERROR : cannot lock target (" << ex.message << ")"
+    end
+  end
+
+  # 1 format_log for all loggers.
+  def format_log(message, mlevel)
+    if @@target
+      # indicate if a registered class or the registered object of a class is calling. 
+      name = self.class == Class ? self.name.dup << ' [class]' : (self.class.name == 'Object' ? 'Top Level' : self.class.name)
+      lock_target{@@target.puts '' << name << ' ' << mlevel.to_s << ' ' << Time.now.strftime("%H:%M:%S:%6N")  << ': ' << message.gsub("\n", "\n |")}
+    end
+  end
+end
+#---------test: execute file----------
+if $0 == __FILE__
+  Array.extend(BasicLogging)
+  Array.set_level(BasicLogging::INFO)
+  Array.info('TEST')
+  ar = Array.new
+  ar.extend(BasicLogging)
+  # --- no output : 
+  l = __LINE__
+  ar.debug(l.next.to_s << ': debug-test 0')
+  # output
+  ar.set_level(BasicLogging::DEBUG)
+  l = __LINE__
+  ar.debug(l.next.to_s << ': debug-test 1')
+
+  obj = Object.new
+  obj.extend(BasicLogging)
+  obj.set_level(BasicLogging::DEBUG)
+  puts "--------debug-----------"
+  obj.debug('debug')
+  obj.info('info')
+  obj.warn('warn')
+  obj.error('error')
+  obj.fatal('fatal')
+  puts "--------info-----------"
+  obj.set_level("info")
+  obj.debug('debug')
+  obj.info('info')
+  obj.warn('warn')
+  obj.error('error')
+  obj.fatal('fatal')
+  puts "--------fatal-----------"
+  obj.set_level("fatal")
+  obj.debug('debug')
+  obj.info('info')
+  obj.warn('warn')
+  obj.error('error')
+  obj.fatal('fatal')
+  puts "--------UNKNOWN-----------"
+  obj.set_level(nil)
+  obj.debug('debug')
+  obj.info('info')
+  obj.warn('warn')
+  obj.error('error')
+  obj.fatal('fatal')
+  puts " ------ Output into file ----"
+  obj.set_target "/tmp/test_log.log"
+  puts " ------ INFO -----------"
+  obj.set_level BasicLogging::INFO
+  obj.info('info output')
+
+  obj.info('info output 2') 
+  puts "---------- invalid -------"
+  obj.set_target "/dev/sr0"
+  obj.set_level "power"
+end
+
+# EOF 

data/lib/basic_logging.rb

@@ -2,7 +2,7 @@
 #encoding: UTF-8
 =begin
 /***************************************************************************
- *   2023-2025, Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *   2023-2026, 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, see                     * 
  *   http://www.wtfpl.net/about/                                           *
@@ -34,7 +34,7 @@ module BasicLogging
   @@log_level = UNKNOWN
   @@target = STDOUT
   @@muted = []
-
+  
   # do not log, if caller is obj (class or instance)
   def self.mute(obj)
     name = obj.class == Class ? obj.name.dup : obj.class.name
@@ -57,7 +57,7 @@ module BasicLogging
     if(!lv || (lv.respond_to?(:to_int) && lv >= DEBUG && lv <= FATAL) )
       @@log_level = lv
     else
-      msg = __FILE__.dup << ": ERROR : invalid log level \"" << lv.to_s << "\""
+      msg = calling_method << ": ERROR : invalid log level \"" << lv.to_s << "\""
       msg << "\n" << "Keepinng old log level " << Levels.keys.detect {| k| Levels[k] == @@log_level}.to_s
       STDERR.puts msg
       puts msg
@@ -73,14 +73,14 @@ module BasicLogging
     elsif !tg || tg.respond_to?(:to_str) && tg.strip.empty?
       @@target = nil
     else
-      STDERR.puts __FILE__.dup << ': ERROR : target ' << tg << ' cannot be set'
+      STDERR.puts calling_method << ': ERROR : target ' << tg.to_str << ' cannot be set'
       STDERR.puts "Keeping old target " << @@target.inspect
       return
     end
   end
 
-  # Output of log messages, depending on the log level set for the calling class
-  # and the name of the alias method which is actually called.
+  # Output of log messages, depending on the set log level and the name of the
+  # alias method which is actually called.
   def log(message)
     if !BasicLogging.is_muted?(self)
       # how has this method been called?
@@ -90,7 +90,7 @@ module BasicLogging
         # the calling alias.
         format_log( message, mlevel) if @@log_level && Levels[mlevel] >= @@log_level 
       else
-        STDERR.puts __FILE__.dup << ": ERROR : invalid log level \"" << mlevel.to_s << "\""
+        STDERR.puts calling_method << ": ERROR : invalid log level \"" << mlevel.to_s << "\""
       end
     end
   end
@@ -110,6 +110,21 @@ module BasicLogging
     end
   end
 
+  # find the name of the calling object's class or the file name in case of the
+  # top level object... or any dumb instance of Object
+  def log_name()
+    if !@log_name
+      clname = self.class.name
+      # limit analysis of the call stack to 'Object'.
+      if clname == 'Object'
+        @log_name = File::basename(caller.last.split(':')[0])
+      else 
+        @log_name = self.class == Class ? self.name.dup << ' [class]' : clname 
+      end
+    end
+    @log_name 
+  end
+
   alias :debug :log
   alias :info :log
   alias :warn :log
@@ -118,6 +133,31 @@ module BasicLogging
 
   private 
 
+  # Find the method that called, or 'main' in case of a top level Object.
+  # This needs a bunch of memory and slows down the process.
+  # Use of this method should be limited.
+  def calling_method()
+    # find instances other than the current module.
+    stack_item = caller.detect do |item|
+      item.split(':')[0] != __FILE__
+    end
+    if stack_item
+      if stack_item.include?('#')
+        m = stack_item.split(':').last.split("#")[1] 
+        m.gsub!("'", '') if m && m.include?("'")
+        # looks cooler with a class name in front.
+        return '#' << m << '()'
+      else
+        # top level Object
+        return stack_item.split(':').last
+      end
+    else
+      # This is dumb but won't hurt a lot.
+      return 'from main'
+    end
+  end
+  
+  # could be useful
   def lock_target(&block)
     begin
       if @@target.respond_to?(:flock) 
@@ -128,19 +168,27 @@ module BasicLogging
         block.call
       end
     rescue => ex
-      STDERR.puts __FILE__.dup  << ": ERROR : cannot lock target (" << ex.message << ")"
+      STDERR.puts calling_method  << ": ERROR : cannot lock target (" << ex.message << ")"
     end
   end
 
   # 1 format_log for all loggers.
   def format_log(message, mlevel)
     if @@target
+      location = log_name().dup << ' ' 
+      # Limit the memory-hungry analysis of the call stack
+      # This also takes about 2.5 times as long.
+      if mlevel != :info 
+        location = log_name().dup << ' ' << calling_method << ' ' 
+      end
       # indicate if a registered class or the registered object of a class is calling.
-      name = self.class == Class ? self.name.dup << ' [class]' : self.class.name
-      lock_target{@@target.puts '' << name << ' ' << mlevel.to_s << ' ' << Time.now.strftime("%H:%M:%S:%6N")  << ': ' << message.gsub("\n", "\n |")}
+      lock_target{@@target.puts '' << location << mlevel.to_s << ' ' << Time.now.strftime("%H:%M:%S:%6N")  << ': ' << message.gsub("\n", "\n |")}
     end
   end
-end
+end # Module end
+
+
+
 #---------test: execute file----------
 if $0 == __FILE__
   Array.extend(BasicLogging)
@@ -186,14 +234,14 @@ if $0 == __FILE__
   obj.warn('warn')
   obj.error('error')
   obj.fatal('fatal')
-  puts " ------ Output into file ----"
+  # ---- into file ---
   obj.set_target "/tmp/test_log.log"
-  puts " ------ INFO -----------"
+  puts "------ INFO into #{obj.target}-----------"
   obj.set_level BasicLogging::INFO
   obj.info('info output')
 
   obj.info('info output 2') 
-  puts "---------- invalid -------"
+  puts "---------- invalid (fails) -------"
   obj.set_target "/dev/sr0"
   obj.set_level "power"
 end

data/lib/body.rb

@@ -20,6 +20,7 @@ require_relative 'configuration'
 WRAP_LENGTH = 65
 # Endow the String class with a wrap function.
 # This is not yet applicable to the message body, itself.
+
 class String
   include BasicLogging
   public

data/lib/color_output.rb

@@ -33,22 +33,48 @@ STYLES = {:regular => REGULAR, :bold => BOLD, :underline => UNDERLINE, :blink =>
 # Colorizes the given text. Color-code is either an escape-sequence or one of
 # the symbols representing color-names in the COLORS hash.
 def colorize(text, color_code)
-  if (COLORS.keys.include?(color_code) )
-    "\033[3#{COLORS[color_code]}m#{text}\033[0m"
+  # ensure that colors are supported
+  if $stdout.tty? && ENV['TERM'] != 'dumb'
+    if (COLORS.keys.include?(color_code) )
+      "\033[3#{COLORS[color_code]}m#{text}\033[0m"
+    else
+      "#{color_code}#{text}\033[0m"
+    end
+    # if Terminal does not support colors
   else
-    "#{color_code}#{text}\033[0m"
+    text
   end
 end
 
+# rgb foreground
+def colorize_RGB(text, r, g, b)
+  code = "%s;%s;%s" %[r, g, b]
+  "\033[38;2;#{code}m#{text}\033[0m"
+end
+
+# rgb background
+def background_RGB(text, r, g, b)
+  code = "%s;%s;%s" %[r, g, b]
+  "\033[48;2;#{code}m#{text}\033[0m"
+end
+
+# duplicate code without much intelligence
 def style(text, style_code)
   "#{style_code}#{text}\033[0m"
 end
+
 # a function which allows to manipulate every known aspect of the ansi-output.
 def colored_output(output_text, fg_color = :default, bg_color = :default, style = :regular , mode = :neutral )
-  "\033[%i;%i;%i%i;%i%im%s\033[0m" %[STYLES[mode.to_sym], STYLES[style.to_sym], FG, COLORS[fg_color.to_sym], BG, COLORS[bg_color.to_sym], output_text]
+  if $stdout.tty? && ENV['TERM'] != 'dumb'
+    "\033[%i;%i;%i%i;%i%im%s\033[0m" %[STYLES[mode.to_sym], STYLES[style.to_sym], FG, COLORS[fg_color.to_sym], BG, COLORS[bg_color.to_sym], output_text]
+  else
+    # fallback for terminals that do not support colors.
+    output_text
+  end
 end
 
 # convenience functions
+def black(text); colorize(text, "\033[30m"); end
 def red(text); colorize(text, "\033[31m"); end
 def green(text); colorize(text, "\033[32m"); end
 def yellow(text); colorize(text, "\033[33m"); end
@@ -57,9 +83,20 @@ def cyan(text); colorize(text, "\033[36m"); end
 def blue(text); colorize(text, "\033[34m"); end
 def white(text); colorize(text, "\033[37m"); end
 
+# RGB
+# TODO: Fallbacks from the 256 color palette
+def orange(text); colorize(text, "\033[38;2;255;165;0m"); end
+def pink(text); colorize(text, "\033[38;2;255;0;165m"); end
+def lightred(text); colorize(text, "\033[38;2;255;100;100m"); end
+def lightgreen(text); colorize(text, "\033[38;2;100;255;100m"); end
+def brown(text); colorize(text, "\033[38;2;153;76;0m"); end
+def crimson(text); colorize(text, "\033[38;2;220;20;60m"); end
+
+# quick contrast
 def black_on_white(text); colorize(colorize(text, "\033[30m"), "\033[47m");end
 def white_on_black(text); colorize(colorize(text, "\033[37m"), "\033[40m");end
 
+# styles
 def bold(text); style(text, "\033[01m");end
 def underline(text); style(text, "\033[04m");end
 

data/lib/configuration.rb

@@ -78,6 +78,7 @@ class Configuration
   def update_config(i_config)
     if @conf
       conf_version = @conf[:CONFIG_VERSION]
+      debug 'conf_version is ' << conf_version.to_s
       if !conf_version || conf_version < PROGVERSION.to_f
         info "configuration has an older version number, looking for changes"
         i_conf = YAML::load_file(i_config)

data/lib/flnews_post_proc.conf

@@ -17,7 +17,7 @@
 # the process, if they are still valid.
 # ATTN! COMMENTS WILL BE REMOVED but a copy of your previous configuration
 # will be saved in a file with a version suffix.
-CONFIG_VERSION: 1.35
+CONFIG_VERSION: 1.95
 
 # FUP_NAME 
 # A Regular Expression, describing the string which contains the name of
@@ -169,5 +169,19 @@ VFY_URLS: No
 # DEFAULT: yes
 OVERRIDE_CONFIG: YES
 
+# USE_OLD
+# A Boolean constant. The post processor can handle subject changes in the way, that
+# old subjects which are preceded by variations of the string '(Was:' are automatically
+# removed from the header. This imposes, that our own subject changes must be ignored!
+# This behavior is activated here and necessitates that our own subject changes
+# are indicated with a prefix "(Old:". It will be replaced by "(Was:" in the
+# posted article.  
+#
+# Set this option to true, when you want to use the prefix
+# "(Old:", or to false, no, NO or similar if you do not want subject changes
+# handled by the program.
+# DEFAULT: No
+USE_OLD: false
+
 # EOF
 

data/lib/headers.rb

@@ -1,7 +1,7 @@
 #encoding: UTF-8
 =begin
 /***************************************************************************
- *   2023-2025, Michael Uplawski <michael.uplawski@uplawski.eu>            *
+ *   2023-2026, 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, see                     * 
  *   http://www.wtfpl.net/about/                                           *
@@ -13,6 +13,7 @@
  ***************************************************************************/
 =end
 
+require 'rfc_2047'
 require_relative 'basic_logging'
 require_relative 'configuration'
 require_relative 'newsgroups'
@@ -81,10 +82,9 @@ class Headers
         headers[cur_header] = val
       end
     end
-
+    
     return headers
   end
-
   def self::supersedes?(article_text)
     headers(article_text).keys.include?(:Supersedes)
   end
@@ -124,6 +124,10 @@ class Headers
       @headers["X-No-Archive".to_sym] = no_archive
       @headers["Archive".to_sym] = 'no'
     end
+    # ------->
+    # check for altered Subject and impose the newer value
+    alterSubject()
+    # <----
     if @config.CUSTOM_HEADERS    
       ch = @config.CUSTOM_HEADERS
       debug('setting custom headers : ' << ch.inspect)
@@ -131,15 +135,18 @@ class Headers
         ch = pair.split(':')
         hn = ch[0].strip
         hv = ch[1].strip
-        # Ensure header is as only
+        # Ensure header is ascii only
         if hv.ascii_only? && hn.ascii_only?
           # <---------- special treatment Post-Processor ---------->
           hv << ' ' << PROGVERSION.to_s if hn == 'X-Post-Processor' && hv == 'flnews_post_proc'
           #  >----------<
           @headers[hn.to_sym] = hv
         else
-          warn "Custom header [#{hn}:#{hv}] should be ASCII only! Header is ignored!"
+          warn "Custom header [#{hn}:#{hv}] should be ASCII only! But I try to encode it..."
+          hv = hv.split.collect{|w| (w.ascii_only? ? w : Rfc2047.encode(w, encoding: :Q)) }.join(' ')
+          debug '   custom header encoded'
         end
+        @headers[hn.to_sym] = hv
       end
       @headers.compact!
     end
@@ -173,6 +180,74 @@ class Headers
 
   attr_reader :lines, :newsgroups
 
+  private
+
+  # Check for was, war, était and clip the old subject header.
+  # Currently UNUSED
+  def alterSubject
+    if @config.USE_OLD
+      refs = @headers[:References]
+      # only if older articles exist in the thread
+      if refs && !refs.empty?
+        hv = @headers[:Subject]
+        if hv
+          debug 'checking for altered Subject'  
+          
+
+          # Our own very first article with an altered subject line, uses:
+          # (old: 
+          # because this is what we do.
+
+          old = /\(Old:/i
+          if hv.match(old)
+            debug "\tfound old"
+            if hv.split(old).length == 2
+              @headers[:Subject]= hv.sub(old, '(Was:')
+              debug 'Subject is now: ' << @headers[:Subject]
+              return
+            end
+          end
+          # Handle previous subject changes.
+          # Create some regexps
+          olds = Array.new
+          olds << /\s*\(was:.*/i
+          olds << /\s*\(war:.*/i
+          olds << /\s*\(était\s?:.*/i
+          olds << /\s*\(etait\s?:.*/i
+
+          #decode subject from header value
+          subj = Rfc2047.decode(hv)
+          debug 'subject encoding: ' << hv.encoding.to_s
+          debug 'decoded subject: ' << subj
+          # check for each of those regexps
+          olds.each do |old| 
+            m = subj.match(old)
+            debug "matches prefix #{old}?" << (m ? m.to_s : ' NO!')
+            # works too, but contains empty strings, if not
+            # parts = subj.partition(old) if m
+            # simpler:
+            parts = subj.split(old) if m
+            debug 'partitioned subject ' << parts.inspect
+            if parts 
+              # ---> do not understand why this is needed:
+              new_subject = parts[0].strip('(')
+              # <--- but it is
+              # encode if you must.
+              new_subject = new_subject.split.collect{|w| (w.ascii_only? ? w : Rfc2047.encode(w, encoding: :Q)) }.join(' ')
+              # encode everything.
+              #new_subject = new_subject.ascii_only? ? new_subject : Rfc2047.encode(new_subject, encoding: :Q)
+              # probably unneeded
+              @headers[:Subject] = new_subject.force_encoding('UTF-8')
+              debug 'subject is now: ' << @headers[:Subject]
+              return
+            end
+          end
+        end
+      end
+    else
+      info('subject changes are ignored')
+    end
+  end
 end
 # EOF
 

data/lib/version.rb

@@ -14,8 +14,8 @@
 =end
 
 PROGNAME = 'flnews_post_proc'
-PROGVERSION = "1.94"
+PROGVERSION = "1.97"
 AUTHORS = "Michael Uplawski"
 EMAIL = "michael.uplawski@uplawski.eu"
 YEARS = "2023 - 2026"
-SUMMARY = "Documentation improved (concerns mainly the PDF)"
+SUMMARY = "Custom headers are rfc2047 encoded, if need be"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: flnews_post_proc
 version: !ruby/object:Gem::Version
-  version: '1.94'
+  version: '1.97'
 platform: ruby
 authors:
 - Michael Uplawski
 bindir: bin
 cert_chain: []
-date: 2026-01-26 00:00:00.000000000 Z
+date: 2026-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -68,6 +68,7 @@ files:
 - doc/pdf/flnews_post_proc.pdf
 - doc/rst/flnews_post_proc.rst
 - lib/_quoting_style_regexp
+- lib/bak_basic_logging.rb
 - lib/basic_logging.rb
 - lib/body.rb
 - lib/color_output.rb
@@ -101,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.4
+rubygems_version: 4.0.13
 specification_version: 4
-summary: Documentation improved (concerns mainly the PDF)
+summary: Custom headers are rfc2047 encoded, if need be
 test_files: []