flnews_post_proc 1.45 → 1.48

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c48262d6fc3031346ffa1e2b528e11a696cef83b6d7c64fa98cdef444cf60247
-  data.tar.gz: 12e53f1d88d613d14671ed06f03c0e65ca5f438088c85a66c22d3e37beec9b61
+  metadata.gz: 9a019c52dac602a5b00c71131e8b44a61769604a08035b7afad305a27c5d43a0
+  data.tar.gz: 7f5a69f62df2a18fefe9f0f5f499d7960d40b751b4bda67f26a88f91034ac941
 SHA512:
-  metadata.gz: f1845950986bcb9919a4ad353c4913a9fca9427f2387bb8a4cbe7b1968eaf26f35d837f331dd9d3f9a1ab5c49b8e9a49d7868f89902c7b9f427d2592e73dc607
-  data.tar.gz: f87ff6d5bd9462ebf3988b23482b64d6bb3d7ced99fbeecb06cc6c271392b65b7d8a510cd69e7e83c6792775ffbceb6e6dc1a6313b0bb2abd335752f508655ba
+  metadata.gz: fe1d5fee2fffc214f8aa96b34e4886b3c2e7b16a71dd2ac99b8df214528d53c43df8b425fe4b21d4edf58e691e6cd5f497e09ed12a81129dd0f0e883fcf9ab76
+  data.tar.gz: 40f0b45424e01cc6b034aeeb4a7729bb0a499e231eb0001a60d762e4f1952964090dacda102fb87215ed66786e7e2887c471c95cc930018b469df669d16915b1

data/README.md

@@ -93,14 +93,14 @@ some users may not always agree with the result and for arbitrary reasons:
   Custom headers may be defined in the configuration file for the program  
   and will then be added to each outgoing post.
 
-* The Archive- and X-No-Archive headers are sometimes set to avoid that an
-  article be saved and stays available to search-engines (Google, notably).
-  Test-  postings, for example, do probably not justify at all that they would
-  be  referenced in search results. The post-processor program can impose the
-  Archive- and X-No-Archive header for all posts to certain newsgroups.
-
-  **ATTN** As of 2024, the X-No-Archive has lost most of its utility and it 
-  is the decision of server operators to honor it or not.
+* The Archive- and X-No-Archive headers are sometimes set to avoid that an 
+  article be saved and stays available to search-engines (Google, notably). 
+  Test-  postings, for example, do probably not justify at all that they would 
+  be  referenced in search results. The post-processor program can impose the 
+  Archive- and X-No-Archive header for all posts to certain newsgroups. 
+
+  **ATTN** As of 2024, the header “X-No-Archive“ has lost most of its utility 
+  and it is the decision of server operators to honor it or not.  
 
 * If a news post contains many references to either other posts or Web  
   pages, the text can be cluttered with URLs.  

data/bin/flnews_post_proc

@@ -1,5 +1,6 @@
 #!/bin/env ruby
 #encoding: UTF-8
+
 =begin
 /***************************************************************************
  *   ©2023-2024, Michael Uplawski <michael.uplawski@uplawski.eu>           *
@@ -32,7 +33,6 @@ self.extend(BasicLogging)
 
 msg = PROGNAME.dup << ' ' << PROGVERSION << ' starting' 
 msg = "–––––– " << msg << " ––––––"
-
 info msg
 # Get a configuration 
 config = Configuration::instance

data/lib/basic_logging.rb

@@ -48,26 +48,30 @@ module BasicLogging
 
   # set the log level 
   def set_level(lv)
-    if lv.respond_to?(:to_str)
+    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
-      STDERR.puts __FILE__.dup << ": ERROR : invalid log level \"" << lv.to_s << "\""
-      STDERR.puts "Keepinng old log level " << Levels.keys.detect {| k| Levels[k] == @@log_level}.to_s
+      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 || tg.strip.empty?
-      @@target = nil
-    elsif tg.respond_to?(:to_io) 
+    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
@@ -91,22 +95,50 @@ module BasicLogging
     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
 
-  attr_reader :target, :log_level
 
   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
-      @@target.puts '' << name << ' ' << mlevel.to_s << ' ' << Time.now.strftime("%H:%M:%S:%6N")  << ': ' << message.gsub("\n", "\n |")
+      lock_target{@@target.puts '' << name << ' ' << mlevel.to_s << ' ' << Time.now.strftime("%H:%M:%S:%6N")  << ': ' << message.gsub("\n", "\n |")}
     end
   end
 end

data/lib/body.rb

@@ -87,7 +87,7 @@ class Body
             i = i.next
             line = @lines[i]
           end
-          # check if there is a citation, at all
+          # check if there is a quote, at all
           if(line.start_with?('>'))
             debug("\tfound intro " << ointro)
             # variables are part of the $intro.
@@ -119,9 +119,13 @@ class Body
   end
 
   def join 
-    return @lines.join("\r\n")
+    return @lines.join("\r\n") << "\r\n"
   end
- 
+  # ------->
+  # TODO : Concentrate all URL/URI munging functionality in 1 or 2 helper
+  # classes, e.g. Body::News and Body::Http
+  # <------ 
+  
   # Verify and possibly correct links in the post.
   # Simple.
   def handle_urls() 

data/lib/configuration.rb

@@ -25,7 +25,6 @@ class Configuration
   include Singleton
   include BasicLogging
 
-  self.extend(BasicLogging)
 
   def initialize() 
     debug 'Configuration::initialize()'
@@ -115,12 +114,16 @@ class Configuration
     if File::exist?(@config_file) && File::readable?(@config_file)
       begin
         @conf = YAML::load_file(@config_file)
+
         @conf.transform_keys!{|k| k.to_sym}
         @keys = @conf.keys
         clevel = @conf[:LOG_LEVEL]
         set_level clevel
-        set_target @conf[:DEBUG_LOG]
-        debug('log target and -level set: ' << @@log_level.to_s << ', ' << @@target.path)
+        target_string = @conf[:DEBUG_LOG]
+        set_target (target_string == 'STDOUT' ? STDOUT : target_string)
+        # clear the log file.
+        clear_log
+        debug('log target and -level set: ' << @@log_level.to_s << ', ' << target_string)
       rescue Exception => ex
         msg = ex.message
         error msg

data/lib/flnews_post_proc.rb

@@ -29,11 +29,10 @@ $LN = "\r\n"
 # The main application class.
 #  Does it.
 class PostProcessor
-  # class-level configuration object
-  @@config = Configuration.instance
   include BasicLogging  
 
   def initialize(article_text)
+    @config = Configuration.instance
     # for simplicity.
     # separate the headers and the body.
     debug ' initializing headers'

data/lib/headers.rb

@@ -20,13 +20,12 @@ require_relative 'newsgroups'
 # an object of this class represents the headers of a news-article
 
 class Headers
-  # class-level configuration object
-  @@config = Configuration.instance
   include BasicLogging
 
   # read the headers from the article
   def initialize(article_text)
     
+    @config = Configuration.instance
     line = nil
     # transform the article to an array.
     debug('before split, article_text is : ' << article_text)
@@ -105,10 +104,10 @@ class Headers
       @headers["X-No-Archive".to_sym] = no_archive
       @headers["Archive".to_sym] = 'no'
     end
-    if @@config.CUSTOM_HEADERS    
-      ch = @@config.CUSTOM_HEADERS
+    if @config.CUSTOM_HEADERS    
+      ch = @config.CUSTOM_HEADERS
       debug('setting custom headers : ' << ch.inspect)
-      @@config.CUSTOM_HEADERS.each do |pair| 
+      @config.CUSTOM_HEADERS.each do |pair| 
         ch = pair.split(':')
         hn = ch[0].strip
         hv = ch[1].strip

data/lib/newsgroups.rb

@@ -20,11 +20,10 @@ require_relative 'configuration'
 require_relative 'basic_logging'
 
 class Newsgroups
-  # class-level configuration object
-  @@config = Configuration.instance
-  include BasicLogging  
 
+  include BasicLogging  
   def initialize(groups)
+    @config = Configuration.instance
     @groups = groups.split(',')
     debug('set signature, intro, no_archive')
     # set details for this post
@@ -50,7 +49,7 @@ class Newsgroups
     # only one group.
     group = @groups[0]
     # all configured intro-lines.
-    gintros = @@config.GROUP_INTROS
+    gintros = @config.GROUP_INTROS
 
     if gintros && gintros.respond_to?(:to_hash)
       # find the intro for the group.
@@ -93,7 +92,7 @@ class Newsgroups
     @signature = nil
     # 1 group
     group = @groups[0]
-    gsigs = @@config.GROUP_SIGS
+    gsigs = @config.GROUP_SIGS
 
     if gsigs && gsigs.respond_to?(:to_hash)
       # find the signature for the group
@@ -124,7 +123,7 @@ class Newsgroups
   # define the no_archive header.
   def set_no_archive
     @no_archive = nil
-    xgs = @@config.NO_ARCHIVE_GROUPS
+    xgs = @config.NO_ARCHIVE_GROUPS
     if xgs && !xgs.empty? && xgs.detect {|g| @groups[0].match(g) }
       debug("setting no_archive")
       @no_archive = 'yes' 

data/lib/version.rb

@@ -14,8 +14,9 @@
 =end
 
 PROGNAME = 'flnews_post_proc'
-PROGVERSION = "1.45"
+PROGVERSION = "1.48"
 AUTHORS = "Michael Uplawski"
 EMAIL = "michael.uplawski@uplawski.eu"
 YEARS = "2023 - 2024"
-SUMMARY = "Bugfix: URLs exclude punctuation and others at the end."
+SUMMARY = "\tConcurrent access to the log file\n\tLog cleared upon setting log target"
+SUMMARY << "\n\t\"STDOUT\" allowed as log target"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flnews_post_proc
 version: !ruby/object:Gem::Version
-  version: '1.45'
+  version: '1.48'
 platform: ruby
 authors:
 - Michael Uplawski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-11 00:00:00.000000000 Z
+date: 2024-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -82,8 +82,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.20
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: 'Bugfix: URLs exclude punctuation and others at the end.'
+summary: Concurrent access to the log file Log cleared upon setting log target "STDOUT"
+  allowed as log target
 test_files: []