flnews_post_proc 1.7 → 1.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c864ce301d84082376b2d6662eab044a8b9386d7fc59bea42ffa457811687d7
-  data.tar.gz: deb232cd41c1d3e8c96052eace342f022d440039beeb5b644e0697ecc3209888
+  metadata.gz: f76e4432bd460f49ef15abd469ac4f79e1c4887c99229620b0a79ec9cb8ad836
+  data.tar.gz: a6416c6b5f53bdfb9995e1b64accadf97a18fbb2b2dc69b36f4aff86e38f35e3
 SHA512:
-  metadata.gz: 523e37695eaef8c553b9458d7eba015e54ac709370368de54377f6b91c6a837a225f2f885e2c88b28aaf887ac33d4344f6d2b5b600e17f45e847c32327941ec9
-  data.tar.gz: 8c2c7747e1209268bedca5468c4cbc19251bab962c0783990444e0739042b7bf22444d714b466e656825ba0d8b76642d5eebf985a31c407049fc6a6c0d31e7e3
+  metadata.gz: 4f331c0092c7ffeb7ac6b8ee485de68a8ad30534166b65b6be049d6b1d16a3a0a7754396da615dc397a6dd17ffdbf555363e4d41576a604963d09b21c4834031
+  data.tar.gz: 057cf2f67069ac2708d8b2444a6339b4671415bd55e86662f23d2ced0d95e5a7e80b69c3514123dab71a1edceab3717f346de7c876119c7c68bb6f31179dc3bb

data/README.md

@@ -7,12 +7,12 @@
 Please give priority to the documentation which is delivered with the gem  
 file, as the markdown syntax plays tricks, sometimes, and I may not be  
 quick enough to correct this file. This applies especially to the section   
-[_Configuration_](#CONFIGURATION), below.  
+[_Configuration_](#CONFIGURATION), below.
 
-The gem-file contains different formats of the man-page in English and French. 
-See section [_Source Code_](Source-Code), below, for instructions to access 
-these texts.  Or see the same files [on the  
-Web](https://www.uplawski.eu/div/flnews/). 
+The gem-file contains different formats of the man-page in English and French.
+See section [_Source Code_](Source-Code), below, for instructions to access
+these texts.  Or see the same files [on the
+Web](https://www.uplawski.eu/div/flnews/).
 
 SYNOPSIS
 =======================
@@ -56,7 +56,7 @@ The flnews newsreader is sufficient for Usenet access, i.e. to receive and read
 articles from -, as well as to write and post articles to newsgroups.
 
 When you compare news-clients, you will always notice the differences and  
-choose the software that you prefer. flnews however, has the charm that you can  
+choose the software that you prefer. Flnews however, has the charm that you can  
 influence how the program itself works but also modify posts that flnews  
 produces, just before the program will transmit them to the chosen nntp-server.
 
@@ -83,8 +83,7 @@ some users may not always agree with the result and for arbitrary reasons:
   would like to replace it against another, based on the newsgroup you are  
   about to post to.  
   The post-processor program sets specific signatures as configured for one  
-  or several newsgroups. You can even define a list of signatures and have
-  the program pick one from the list.
+  or several newsgroups.  
 
 * Some custom headers may serve to convey additional information to  
   interested readers of your post, like GnuPG key IDs, your language skills  
@@ -94,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.  
+* The X-No-Archive header is 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 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.  
+  **ATTN** As of 2024, this header might serve no purpose any more.
 
 * If a news post contains many references to either other posts or Web  
   pages, the text can be cluttered with URLs.  
@@ -116,8 +115,8 @@ some users may not always agree with the result and for arbitrary reasons:
 
 * The program can attempt to correct ill formatted references. This is an  
   option, you can disable it by setting the option VFY_URLS to “no” in the  
-  configuration. Only URLs starting with http or https are currently 
-  handled.
+  configuration. Beware that mailto: links are not recognized and cannot be  
+  corrected. See the explanations for VFY_URLS, below.
 
 Dialog to override settings
 ---------------------------
@@ -130,7 +129,7 @@ have not yet been set in the configuration.
 * Signatures, as set in the configuration **can be ignored**. Either  
   a default signature will appear as set in flnews or none.  
 * Custom Headers, if configured, can be **omitted**.  
-* Archive- and X-No-Archive headers, if set for the current newsgroup, **can be
+* The X-No-Archive header, if set for the current newsgroup, **can be  
   ignored**.  
 * The verification & correction of references **can be disabled**.  
 * Logging can be **switched off**, if set.
@@ -158,11 +157,6 @@ categories:
 
 * Variables defining the new or altered content.  
 
-*ATTENTION*: Most problems that occurred with recent versions of
-*flnews_post_proc* were caused by inadequate option values and very often ill
-chosen or mal formatted regular expressions. PSE double check your
-configuration, if the program does not seem to work normally.
-
 **FUP_NAME**   
 A Regular Expression, describing the string which contains the name of  
 previous poster who is the author of a quoted post.  This string is  
@@ -172,7 +166,7 @@ Ruby, noted as a String. Beware to mask a backslash '\\' by another one,
 ike in the example. A capture-group '()' serves to extract the name from the  
 match result.
 
-Leave this field empty to keep the default from the flnews configuration  
+Leave this field empty to keep the default from the FLNews configuration  
 intact.
 
  CONTENT: A String equivalent of a regular expression.
@@ -205,15 +199,12 @@ intact.
 
  CONTENT: A newsgroup or regexp per line, followed by a colon, a space and a String
 
- DEFAULT: As configured in flnews
+ DEFAULT: As configured in FLNews
  
  EXAMPLE: _alt.test: "Thus spoke #\{fup_name\} on that baleful #\{fup_date\}:"_
 
 **GROUP_SIGS**  
  A signature line per Newsgroup.  
- If a file is named instead, the program will pick randomly one signature from
- that file. The file should contain signatures, separated by 1 empty line. 
-
  ATTN! In multi line signatures, you have to use \r\n for line breaks.
 
  CONTENT: A newsgroup or regexp per line, followed by a colon, a space and a String.  
@@ -221,7 +212,6 @@ intact.
  DEFAULT: As configured in flnews
 
  EXAMPLE: alt.test: _"Signature for alt.test\\\\r\\\\nsecond line"_
- EXAMPLE: comp.*: /home/user/.my_sigs
 
 **CUSTOM_HEADERS**  
  Additional headers for the outgoing article 
@@ -235,10 +225,9 @@ intact.
   _\- 'X-My-Header: nothing fancy'_  
   _\- 'X-Another-Header: care not!'_ 
 
-**NO_ARCHIVE_GROUPS**  
-
- The newsgroups, where the headers “Archive: no” and “X-No-Archive: YES” shall
- be set.  
+**XNAY_GROUPS**  
+ The newsgroups, where a header X-No-Archive: YES shall be set.
+ **ATTN** As of 2024, this header might serve no purpose any more.
 
  CONTENT: a dash and space, then a String, containing the name of the group or   
  a regexp.
@@ -307,11 +296,15 @@ the original message-body contains text marked for use as such a footnote. See
 **VFY_URLS**
 A Boolean constant. It determines if the program shall verify and possibly  
 try to correct URLs. Even if URLs are identified as such, only a few  
-manipulations are attempted :  
+manipulations are attempted :
 
 * Angular brackets '<' and '>' are added, if missing  
+* Article-references are prepended with "news:", if missing   
 * Slashes are added, if they are found missing after "http(s):"  
 
+ATTN! The program is unable to discern "mailto:" and "news:" references. If  
+neither is given, but '@' is present, "news:" is automatically prepended.  
+
 If the variable is not set, a value 'yes' is assumed.
 
 CONTENT: One of YES, yes, NO, no, and other variations of case.
@@ -326,7 +319,7 @@ A dialog may be displayed which allows you to disable any of these
 four options, so that the defaults from flnews prevail.
 
 ATTN! Canceling the dialog or pushing the Esc-key does interrupt   
-the process. flnews will not post the article.
+the process. Flnews will not post the article.
 
 Set this option to no, NO or similar to disable the dialog.
 

data/bin/flnews_post_proc

@@ -1,9 +1,8 @@
 #!/bin/env ruby
 #encoding: UTF-8
-
 =begin
 /***************************************************************************
- *   ©2023-2024, Michael Uplawski <michael.uplawski@uplawski.eu>           *
+ *   ©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 DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE *
@@ -22,73 +21,25 @@ if ! /linux/ =~ RUBY_PLATFORM
   exit false
 end
 
-# needs the ruby-filemagic gem
-# require 'filemagic'
-# require 'marcel'
 require 'tempfile'
-
 require_relative '../lib/override'
 require_relative '../lib/flnews_post_proc'
 require_relative '../lib/basic_logging'
 require_relative '../lib/configuration'
-require_relative '../lib/version'
 
 self.extend(BasicLogging)
-
-def usage
-  usage = "\nWhat do you want me to do? Where is the article to post-process?"
-  usage << "\nUsage: "
-  usage << "\n\t#{$0} < article.text"
-  info usage
-  STDERR.puts usage
-  exit false 
-end
-
-msg = PROGNAME.dup << ' ' << PROGVERSION << ' starting' 
-msg = "–––––– " << msg << " ––––––"
-info msg
 # Get a configuration 
-#   this call results in the configuration file to be
-#   read and interpreted. As the log depends on the
-#   configuration, errors may render the debug-log 
-#   unavailable. See STDERR in these cases, i.e.
-#   call the program on the command-line and pipe-in
-#   a message. Is this okay?
-debug 'creating config'
 config = Configuration::instance
 
-# Store the path to the main executable
-#   ... Forgot what this should be good for.
+# store the path to the main executable
 # config.set(:BINDIR, File::dirname(__FILE__) )
 
 # Only if data is on STDIN
 if (!STDIN.tty?)
   # read from STDIN
   artext = ARGF.read
-
   # There is content, create the post-processor.
-  if !artext.strip.empty? 
-=begin
-# unused
-    if (['news', 'rfc822'].none? {|m|  mime.start_with?('message/' << m) } )
-      # Not a pure news message
-      # Add more reactions, as you stumble upon them ...
-      warn ("Input is of wrong mime-type " << mime.split(';')[0])
-
-      # Javascript okay
-      if (['javascript'].any? {|m| mime.start_with?('application/' << m)} )
-        warn 'Input contains java-script code!'
-      # C okay
-      elsif(['x-c'].any? {|m| mime.start_with?('text/' << m)} )
-        warn 'Input contains C- or C++ code!'
-      # Ruby okay
-      elsif(['x-ruby'].any? {|m| mime.start_with?('text/' << m) })
-        warn 'Input contains Ruby-code!'
-      else
-        warn 'Input contains other things than plain-text, but I cannot say, what.'
-      end
-    end
-=end
+  if !artext.strip.empty?
     #----------->
     # Allow to override the configuration,
     # if not disabled (default is true)
@@ -107,9 +58,8 @@ if (!STDIN.tty?)
       debug('new config: ' << config.inspect)
     end
     #<--------------
-    # Do it:
     pp = PostProcessor.new(artext)    
-    # and get a result.
+    # ... and print its result.
     article = pp.article
     if article 
       # -------------> The main objective <------
@@ -120,9 +70,15 @@ if (!STDIN.tty?)
     # whatever.
     exit false
   else
-    error( "Cannot read the article, no content" ) 
+    error( "Cannot read the article, no content" )
   end
 else
-  usage() 
+  usage = "\nWhat do you want me to do? Where is the article to post-process?"
+  usage << "\nUsage: "
+  usage << "\n\t#{$0} < article.text"
+  info usage
+  STDERR.puts usage
+  exit false 
 end
+
 # Ω