flnews_post_proc 1.7

data/lib/override.rb

@@ -0,0 +1,199 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   2023-2024, 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
+
+# This class manages a dialog to alter the behavior of the
+# post-processor on a “per article” basis. It can be displayed
+# before posting, to do some “last minute” changes,
+# notably to deactivate them.
+#
+# Post-processing CANNOT be deactivated completely in this dialog.
+# I do not remember, why a previous comment stated the contrary.
+
+require_relative 'basic_logging'
+
+class OverrideDlg
+
+  include BasicLogging
+
+  XTERM    = 'xterm'
+  # TERMINAL = 'x-terminal-emulator'
+  WHIPTAIL = 'whiptail'
+  YAD      = 'yad'
+  ZENITY   = 'zenity'
+  # The external programs which are supported for the time. They will be run in
+  # a new process (IO.popen() ).  The first program from this array, which is
+  # found in the Path, will be used. Whiptail and a pure ruby dialog
+  # necessitate that xterm be found, too.
+  @@Executables = [YAD, ZENITY, WHIPTAIL, XTERM]
+  @@LIBDIR = File::dirname(__FILE__)
+  # The configuration variables that can be unset.
+  # This class instance variable is exposed via a getter.
+  @cvars = [:GROUP_SIGS, :CUSTOM_HEADERS, :NO_ARCHIVE_GROUPS, :VFY_URLS, :DEBUG_LOG]
+
+  # ... here
+  # For the record: this is rather cool.
+  #      ... believe me! It is!
+  class << self
+    attr_reader :cvars
+  end
+  # Love it.
+
+  # Create the object
+  def initialize
+    @config = Configuration::instance
+    # find the supported programs 
+    @executables = @@Executables.select do |ex_name|
+      program?(ex_name) 
+    end
+    # As we are calling external programs anyway, 
+    # why not continue with that ...
+    @xmsg = ENV['PATH'].split(':').any? {|d| Dir.children(d).include?('xmessage')}
+    # bof.
+  end
+
+  # display a dialog and return the new options.
+  def show
+    if(@executables && !@executables.empty?)
+      debug('found executables ' << @executables.join(', '))
+      opts = nil
+      begin
+        if has?(YAD)
+          return yad_dlg.split.collect {|o| o.to_s}.join(' ')
+        elsif has?(ZENITY)
+          return zenity_dlg.split.collect {|o| o.to_s}.join(' ')
+        elsif has? XTERM
+          if has?(WHIPTAIL)
+            return whiptail_dlg.split.collect {|o| o.to_s}.join(' ')
+          else
+            debug 'using naked xterm'
+            return ruby_dlg.split.collect {|o| o.to_s}.join(' ')
+          end
+        end
+      rescue SystemExit
+        msg = 'Process is cancelled (SystemExit)'
+        info msg
+        exit true
+      rescue Exception => ex
+        msg = 'Error upon showing dialog ' << ex.message
+        error(msg)
+      end
+    # no program to show the dialog 
+    else 
+      msg = "#{File.basename($0)}: No suitable executable found to display the dialog"
+      warn msg
+      # if xmessage is available, give the user a last chance.
+      if @xmsg
+        io = IO.popen('xmessage -buttons continue:0,abort:1 -default abort -print ' << msg) 
+        Process.wait(io.pid)
+        # ATTN! read io only once!
+        exit if ('continue' != io.read.to_s.strip )
+        # ... but then again, we still have a log.
+        debug('continue with configured settings')
+      end
+    end
+  end
+
+  private
+  # I know what it does and that there is some
+  # redundancy with the following method, but I
+  # do not feel like sorting it out, now.
+  def program?(ex_name)
+    ENV['PATH'].split(':').each do |dir_name| 
+      return true if Dir.entries(dir_name).include?(ex_name) 
+    end
+    return false
+  end
+
+  # returns true if the executable ex_name is to be 
+  # called for the dialog
+  def has?(ex_name)
+    @executables.include? ex_name 
+  end
+
+  ###### The following methods call a script, each, in an external process.
+  # There appears to be some Exception handling missing, but it does not
+  # hurt for the time being. Anyway, I do not care.
+
+  # creates a whiptail dialog in xterm.
+  def whiptail_dlg
+    debug('whiptail dialog')
+    tf = Tempfile.new
+    # dlg = @config.BINDIR << File::Separator << 'whiptail_dlg'
+    dlg = @@LIBDIR << File::Separator << 'whiptail_dlg'
+    dialog = XTERM.dup << ' -e ' << dlg << ' ' << tf.path
+    io = IO::popen(dialog)
+    Process.wait(io.pid )
+    nopts = tf.read
+    exit true if('exit' == nopts.strip)
+    tf.unlink
+    return nopts 
+  end
+
+  # creates a textual dialog in xterm.
+  def ruby_dlg
+    debug('xterm dialog')
+    tf = Tempfile.new
+    # dlg = @config.BINDIR << File::Separator << 'ruby_dlg'
+    dlg = @@LIBDIR << File::Separator << 'ruby_dlg'
+    begin
+      dialog = XTERM.dup  << ' -e ' << dlg << ' ' << tf.path
+      debug('dialog will be ' << dialog)
+    rescue Exception => ex
+      error ex.message
+      wait_for_user
+      exit false
+    end
+    io = IO::popen(dialog)
+    debug('wait for ' << io.pid.to_s)
+    Process.wait(io.pid )
+    nopts = tf.read
+    exit true if('exit' == nopts.strip)
+    tf.unlink
+    return nopts 
+  end
+
+  # creates a Zenity dialog.
+  def zenity_dlg
+    debug('Zenity dialog')
+    # dialog = @config.BINDIR << File::Separator << 'zenity_dlg'
+    dialog = @@LIBDIR << File::Separator << 'zenity_dlg'
+    io = IO.popen(dialog)
+    Process::wait(io.pid)
+    rc = $?.exitstatus 
+
+    exit true if rc != 0
+
+    nopts = io.read
+    return nopts
+  end
+
+  # creates a YAD dialog.
+  def yad_dlg
+    debug('yad dialog')
+    # dialog = @config.BINDIR << File::Separator << 'yad_dlg'
+    dialog = @@LIBDIR << File::Separator << 'yad_dlg'
+    debug('dialog will be ' << dialog)
+    io = IO::popen(dialog)
+    Process::wait(io.pid)
+    exit true if $?.exitstatus != 0
+
+    nopts = io.read
+    return nopts
+  end
+
+end 
+
+# EOF 
+

data/lib/ruby_dlg

@@ -0,0 +1,139 @@
+#!/usr/bin/env ruby
+
+=begin
+/***************************************************************************
+ *   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
+
+require 'readline'
+require_relative '../lib/color_output'
+require 'io/wait'
+require 'io/console'
+
+def wait_for_user()
+  char = nil
+  # There is a difference which makes me prefer the below code from STDIN.raw(args)
+  # You can try
+  # char = STDIN.raw(&:getc)	
+  # .., which does *not* work the same way and it won't for me.
+
+  STDIN.raw do 
+    STDIN.noecho do
+      until (STDIN.ready?)
+        sleep(0.1)
+      end
+      char = (STDIN.read_nonblock(1).ord rescue nil)
+    end
+  end
+  return char
+end
+if !ARGV.empty? && ARGV.length > 0
+  ofl = nil
+  begin
+    ofl = File.open(ARGV[0], 'w+') 
+    puts 'writing to ' << ARGV[0]
+  rescue Exception => ex
+    puts red ('cannot open ' << ARGV[1])
+    puts ex.message
+    puts 'hit any key to exit'
+    wait_for_user
+    exit false 
+  end
+
+  opt_array = []
+  message = ''
+  menu ||= %=
+  1 Unset Signature         GROUP_SIGS 
+  2 Unset Custom headers    CUSTOM_HEADERS
+  3 Unset No Archive        NO_ARCHIVE_GROUPS
+  4 Do not correct URLs     VFY_URLS
+  5 Disable log             DEBUG_LOG
+  ––––––––––––––––––––––––––––––––––––––––––––––
+  6 Summary
+  ––––––––––––––––––––––––––––––––––––––––––––––
+  0 Okay, use settings. 
+––––––––––––––––––––––––––––––––––––––––––––––––
+{bold("Esc, Ctrl+C and 'q'")} terminate the Post-processor 
+and no changes will be applied.
+=
+
+  loop do
+    system 'clear'
+    puts yellow(menu)
+    puts cyan(message)
+    option = wait_for_user - 48
+    case option
+      # Esc, Ctrl+C, 'q'
+    when -21, -45, 65
+      puts red('Aborting. Bye.')
+      ofl.write 'exit'
+      ofl.close
+      exit true
+    when 0
+      puts green('Applying changes.') if !opt_array.empty?
+      # write the list of variables to unset (others remain)
+      ofl.write opt_array.join(' ')
+      ofl.close
+      exit true
+
+      # toggle options
+      # ADD option to the option array, if it should be *removed* 
+      # from the configuration, else remove it from the array.
+    when 1
+      active = !opt_array.include?(:GROUP_SIGS)
+      opt_array << :GROUP_SIGS if active
+      opt_array.delete(:GROUP_SIGS) if !active
+
+      message = "Signature #{active ? 'unset' : 'as configured'}!"
+      menu.sub!("Unset Signature", "Set Signature  ") if active
+      menu.sub!("Set Signature  ", "Unset Signature") if !active
+    when 2
+      active = !opt_array.include?(:CUSTOM_HEADERS)
+      opt_array << :CUSTOM_HEADERS if active
+      opt_array.delete(:CUSTOM_HEADERS) if !active
+
+      message = "Custom headers #{active ? 'removed' : 'are added'}!"
+      menu.sub!("Unset Custom headers", "Add Custom headers  ") if active
+      menu.sub!("Add Custom headers  ", "Unset Custom headers") if !active
+    when 3
+      active = !opt_array.include?(:NO_ARCHIVE_GROUPS)
+      opt_array << :NO_ARCHIVE_GROUPS if active
+      opt_array.delete(:NO_ARCHIVE_GROUPS) if !active
+
+      message = "X-No-Archive #{active ? 'removed' : 'is added'}!"
+      menu.sub!("Unset X-No-Archive", "Add X-No-Archive  ") if active
+      menu.sub!("Add X-No-Archive  ", "Unset X-No-Archive") if !active
+    when 4
+      active = !opt_array.include?(:VFY_URLS)
+      opt_array << :VFY_URLS if active
+      opt_array.delete(:VFY_URLS) if !active
+
+      message = "URLS will #{active ? 'not ' : ''}" <<  "be verified!"
+      menu.sub!("Do not correct URLs", "Correct URLs       ") if active
+      menu.sub!("Correct URLs       ", "Do not correct URLs") if !active
+    when 5
+      active = !opt_array.include?(:DEBUG_LOG)
+      opt_array << :DEBUG_LOG if active
+      opt_array.delete(:DEBUG_LOG) if !active
+
+      message = "Log is #{ active ? 'not ' : ''} " << "written!"
+      menu.sub!("Disable log", "Enable log ") if active
+      menu.sub!("Enable log ", "Disable log") if !active
+    when 6
+      message = "Summary of " << bold('disabled') << " options: " << opt_array.join(' ')
+    end
+  end
+else # ARGV
+  puts red('missing file argument')
+  exit false
+end
+
+

data/lib/version.rb

@@ -0,0 +1,22 @@
+#encoding: UTF-8
+=begin
+/***************************************************************************
+ *   2023-2024, 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
+
+PROGNAME = 'flnews_post_proc'
+PROGVERSION = "1.7"
+AUTHORS = "Michael Uplawski"
+EMAIL = "michael.uplawski@uplawski.eu"
+YEARS = "2023 - 2024"
+SUMMARY = "Reads random signature from file"
+

data/lib/whiptail_dlg

@@ -0,0 +1,84 @@
+#!/bin/bash
+
+#/**************************************************************************
+#*   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.                  *
+#*                                                                         *
+#***************************************************************************/
+
+# A dialog to override configuration options.
+# Whiptail is not as easily deployed here, as other dialogs.
+# The main difficulty arises from the fact that positive defaults 
+# are negated, while a checklist wants to give positive results.
+
+if [ $# -eq 0 ]
+then
+  echo "ERROR: file-argument missing"
+  exit 1
+fi
+OUTFILE="$1"
+
+# empty the file
+truncate $OUTFILE -s0
+
+TITLE="Override post-processor configuration"
+CHECKTITLE="Deselect to disable. Esc or Cancel close the dialog and no changes will be applied."
+
+# These are the configuration variables which can be unset.
+VARS=(GROUP_SIGS CUSTOM_HEADERS NO_ARCHIVE_GROUPS VFY_URLS DEBUG_LOG)
+
+# Checklist options
+options=(GROUP_SIGS 'Signatures' ON CUSTOM_HEADERS 'Custom headers' ON NO_ARCHIVE_GROUPS 'No Archive' ON VFY_URLS 'Correct URLs' ON DEBUG_LOG 'Log' ON)
+
+# show dialog and store results
+result=$(whiptail --title "$TITLE" --checklist "$CHECKTITLE" 13 55 5 "${options[@]}" 3>&1 1>&2 2>&3)
+# which button had been pushed?
+okcancel=$?
+
+# make an array
+read -ra opts <<< $result
+
+# comment out -------->
+echo "cancel/ok ? $okcancel"
+echo $result
+echo "${opts[@]}"
+echo "${#opts[@]}"
+# <--------
+
+# Find deselected options which shall be written to the outfile. 
+# Looks complicated. 
+if [ "$okcancel" -eq 0 ]
+then
+  list=''
+  # check each available variable ...
+  for c in ${VARS[@]}
+  do
+	deactivate=TRUE
+	# ... against the result from the dialog
+	for o in ${opts[@]}
+	do
+	  if [ "$o" == "\"$c\"" ]	
+	  then
+		# ignore if a variable remained checked ...
+		deactivate=FALSE
+	  fi
+	done
+	# ... else write it to the list.
+	if [ "$deactivate" == TRUE ]
+	then
+
+	  list="$list $c"
+	fi
+  done
+  # Heureka.
+  echo "$list" > "$OUTFILE"
+else
+  echo "exit" > "$OUTFILE"
+fi
+
+# Ω

data/lib/yad_dlg

@@ -0,0 +1,53 @@
+#!/bin/bash
+
+#/**************************************************************************
+#*   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.                  *
+#*                                                                         *
+#***************************************************************************/
+
+# A dialog to override configuration options
+
+TITLE="Override post-processor configuration"
+# These are the configuration variables which can be
+# unset.
+GROUP_SIGS=1
+CUSTOM_HEADERS=2
+NO_ARCHIVE_GROUPS=3
+#VFY_URLS=4
+DEBUG_LOG=4
+
+CONF=$(yad --item-separator=" " --title "$TITLE" --image="" --window-icon="" --form \
+  --field="Uncheck to disable options\n<b>Esc and Cancel</b> terminate the post-processor.":LBL ""\
+  --field="Signature":CHK 'true' \
+  --field="Custom-headers":CHK 'true' \
+  --field="No Archive":CHK 'true' \
+  --field="URL Correction":CHK 'true' \
+  --field="Log":CHK 'true') 
+
+if [ $? == 0 ]
+then
+  IFS="|"
+  read -ra C_ARR <<< $CONF
+  CONF=''
+  # ------------->
+  # echo ${C_ARR[@]}
+  # <-------------
+
+  for i in GROUP_SIGS CUSTOM_HEADERS NO_ARCHIVE_GROUPS VFY_URLS DEBUG_LOG
+  do  
+	if [ 'FALSE' == "${C_ARR[$i]}" ]
+	then
+	  CONF="$i $CONF"
+	fi
+  done
+  # signal the fields to disable (others will be ignored)
+  echo $CONF
+else 
+  exit 1
+fi

data/lib/zenity_dlg

@@ -0,0 +1,60 @@
+#!/bin/bash
+
+#/**************************************************************************
+#*   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.                  *
+#*                                                                         *
+#***************************************************************************/
+
+# A dialog to override configuration options
+
+TITLE="Override post-processor configuration"
+# The options are the configuration variables which can be unset.
+
+CONF=$(zenity --title "$TITLE" --text "Deselect options to disable.\n<b>Esc and Cancel</b> terminate the post-processor."\
+  --height 450 --list --checklist --column 'set' --column 'Option' --column '' \
+  TRUE GROUP_SIGS Signature\
+  TRUE CUSTOM_HEADERS "Custom Headers"\
+  TRUE NO_ARCHIVE_GROUPS "No Archive"\
+  TRUE VFY_URLS "Correct URLs"\
+  TRUE DEBUG_LOG Log)
+
+if [ $? == 0 ]
+then
+  IFS="|"
+  read -ra C_ARR <<< $CONF
+  CONF=''
+  # ------------->
+  # echo ${C_ARR[@]}
+  # <-------------
+
+  # for c in GROUP_SIGS CUSTOM_HEADERS NO_ARCHIVE_GROUPS VFY_URLS DEBUG_LOG
+  for c in GROUP_SIGS CUSTOM_HEADERS NO_ARCHIVE_GROUPS DEBUG_LOG
+  do  
+	# disable only the options which are missing in
+	# the Zenity return value
+	disable=1
+
+	for o in "${C_ARR[@]}"
+	do
+	  if [ "$o" == "$c" ]
+	  then
+		disable=
+	  fi
+	done
+
+	if [ $disable ]
+	then
+	  CONF="$CONF $c"
+	fi
+  done
+  # signal the fields to disable (others will be ignored)
+  echo $CONF
+else
+  exit 1
+fi

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: flnews_post_proc
+version: !ruby/object:Gem::Version
+  version: '1.7'
+platform: ruby
+authors:
+- Michael Uplawski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: ruby-filemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+description: Post-processor for Usenet-articles created in flnews
+email: michael.uplawski@uplawski.eu
+executables:
+- flnews_post_proc
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/flnews_post_proc
+- doc/fr/html/flnews_post_proc.html
+- doc/fr/man/flnews_post_proc.1.gz
+- doc/fr/pdf/flnews_post_proc.pdf
+- doc/fr/rst/flnews_post_proc.rst
+- doc/html/flnews_post_proc.html
+- doc/license.txt
+- doc/man/flnews_post_proc.1.gz
+- doc/pdf/flnews_post_proc.pdf
+- doc/rst/flnews_post_proc.rst
+- lib/_quoting_style_regexp
+- lib/basic_logging.rb
+- lib/body.rb
+- lib/color_output.rb
+- lib/configuration.rb
+- lib/flnews_post_proc.conf
+- lib/flnews_post_proc.rb
+- lib/headers.rb
+- lib/newsgroups.rb
+- lib/override.rb
+- lib/ruby_dlg
+- lib/version.rb
+- lib/whiptail_dlg
+- lib/yad_dlg
+- lib/zenity_dlg
+homepage: https://rubygems.org
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Reads random signature from file
+test_files: []