--> v.1.0 (#3)

* Squashed commit of the following:

commit 64730b8d3d31acc3b8596a609fc3b029c3680644
Author: why-not-try-calmer <[email protected]>
Date:   Fri Jan 7 12:30:59 2022 +0100

    ---

commit e658171
Author: why-not-try-calmer <[email protected]>
Date:   Fri Jan 7 01:19:17 2022 +0100

    - implemented link-to-channel

commit 5d69fca
Merge: 381d27d 1ea0b81
Author: why-not-try-calmer <[email protected]>
Date:   Thu Jan 6 22:32:52 2022 +0100

    Merge branch 'master' into dev

commit 381d27d
Author: why-not-try-calmer <[email protected]>
Date:   Thu Jan 6 20:42:40 2022 +0100

    - message deletion now postprocessing

commit 71df3b0
Author: why-not-try-calmer <[email protected]>
Date:   Wed Jan 5 21:00:47 2022 +0100

    ---

commit 6bbfd71
Author: why-not-try-calmer <[email protected]>
Date:   Wed Jan 5 21:00:25 2022 +0100

    ---

commit 8037393
Author: why-not-try-calmer <[email protected]>
Date:   Wed Jan 5 15:19:15 2022 +0100

    - message auto-deletion
    - misssing line break in /start output

commit a74102e
Author: why-not-try-calmer <[email protected]>
Date:   Wed Jan 5 14:34:31 2022 +0100

    ---

commit b83238a
Author: why-not-try-calmer <[email protected]>
Date:   Wed Jan 5 11:02:58 2022 +0100

    ---

commit f8f5876
Author: why-not-try-calmer <[email protected]>
Date:   Wed Jan 5 11:00:24 2022 +0100

    ---

commit 1b7413e
Author: why-not-try-calmer <[email protected]>
Date:   Wed Jan 5 02:42:41 2022 +0100

    ---

commit 278f71b
Author: why-not-try-calmer <[email protected]>
Date:   Wed Jan 5 02:42:25 2022 +0100

    - better times

commit 6194e2d
Author: why-not-try-calmer <[email protected]>
Date:   Wed Jan 5 02:26:55 2022 +0100

    - improved time computation

commit 6e38404
Author: why-not-try-calmer <[email protected]>
Date:   Wed Jan 5 01:01:10 2022 +0100

    - fixed wrongly placed update instruction

commit dff8b38
Author: why-not-try-calmer <[email protected]>
Date:   Tue Jan 4 21:34:16 2022 +0100

    ---

commit cf29a7e
Author: why-not-try-calmer <[email protected]>
Date:   Tue Jan 4 21:14:45 2022 +0100

    - fixed bot was not discard replies

commit d5f1292
Author: why-not-try-calmer <[email protected]>
Date:   Tue Jan 4 16:13:07 2022 +0100

    simplifed code

commit ae1ba13
Author: why-not-try-calmer <[email protected]>
Date:   Tue Jan 4 17:31:47 2022 +0100

    ---

commit 4fc2e28
Author: why-not-try-calmer <[email protected]>
Date:   Tue Jan 4 15:48:48 2022 +0100

    ---

commit f06a761
Author: why-not-try-calmer <[email protected]>
Date:   Tue Jan 4 15:43:52 2022 +0100

    ---

commit 1a1148d
Author: why-not-try-calmer <[email protected]>
Date:   Tue Jan 4 13:59:48 2022 +0100

    - cleaned up interface

commit 3793f25
Author: why-not-try-calmer <[email protected]>
Date:   Tue Jan 4 11:26:02 2022 +0100

    added filters on first batch

commit fb4f9af
Author: why-not-try-calmer <[email protected]>
Date:   Tue Jan 4 10:01:29 2022 +0100

    ---

commit 7efea67
Author: why-not-try-calmer <[email protected]>
Date:   Tue Jan 4 09:52:35 2022 +0100

    ---

commit c8e9b9f
Author: why-not-try-calmer <[email protected]>
Date:   Tue Jan 4 09:46:32 2022 +0100

    ---

commit 6dae0ca
Author: why-not-try-calmer <[email protected]>
Date:   Mon Jan 3 21:57:35 2022 +0100

    ---

commit 63c771d
Author: why-not-try-calmer <[email protected]>
Date:   Mon Jan 3 20:09:37 2022 +0100

    ---

commit 55b1d35
Author: why-not-try-calmer <[email protected]>
Date:   Mon Jan 3 18:33:14 2022 +0100

    ---

commit 78d7a81
Author: why-not-try-calmer <[email protected]>
Date:   Mon Jan 3 17:44:02 2022 +0100

    ---

commit f0778b7
Author: why-not-try-calmer <[email protected]>
Date:   Mon Jan 3 17:15:20 2022 +0100

    ---

commit e0ecec1
Author: why-not-try-calmer <[email protected]>
Date:   Mon Jan 3 16:14:15 2022 +0100

    refactored reusing pipe

* ---

* now postProcJobs worker is concurrent

* - concurrent postprocessing

* ---

* - fixed truncated post titles from reddit

* - new command: /link_channel, /l, taking an 64bit signed integer as unique argument, representing the channel to link
- new command: /channel_settings, taking a string formatted just like the string that is the argument of /settings.
- post-processing queue now threadsafe & concurrent
- fixed some entities in feed items titles that were not escaped appropriately

* ---

* ---

* ---

* ---

* ---

* JobLogs

* - commands

* ---

* ---

* ---

* ---

* ---

* ---

* ---

* ---

* ---

* ---

Author: why-not-try-calmer

COMMANDS.md

@@ -0,0 +1,182 @@
+## Commands
+
+### Subscribe a channel, 1-1 chat, private group, or public group to a web feed
+
+__Any chat but a channel__:
+
+_The user issuing the command must have administrative rights in the chat._
+
+```
+command  | argument
+---------+---------------------------------------------
+/sub     | <list of comma-separated full url addresses> 
+---------+---------------------------------------------
+example  | /sub https://www.reddit.com/r/pop_os.rss     
+---------+---------------------------------------------
+response | error or success message                    
+---------+---------------------------------------------
+```
+
+__Channel__:
+
+_Both the user performing this command and the bot must be admin in the target channel. The command may be issued from any chat with the bot. For a better experience it is recommended to give bot the permission to edit and pin messages._
+
+```
+command  | argument
+---------+-------------------------------------------------------
+/subchan | <chat_id>                                 
+---------+-------------------------------------------------------
+example  | /subchan -25154554 https://www.reddit.com/r/pop_os.rss  
+---------+-------------------------------------------------------
+response | error or success message                               
+---------+-------------------------------------------------------
+```
+
+### View or edit a chat's or channel's settings
+
+Available values:
+
+- `blacklist: term, term, ...`
+    - excludes feed items where a term is found in either their url or description
+    - example: `blacklist: itsmycode, butIamproudofit`
+- `batch_at: HHMM, HHMM, ...`
+    - incompatible with "batch_every"
+    - batch all updates and post them at the given times
+    - example: `batch_at: 0800, 1200, 1800`
+- `batch_every: n`
+    - incompatible with "batch_at"
+    - batch all updates and post them every n seconds
+    - example: `batch_every: 9000` (= 20 minutes)
+- `paused: "true" or "false"`
+    - suspend all notifications to the chat
+- `webview: "true" or "false"`
+    - allow Telegram to display the last shown items in webview mode
+- `pin: "true" or "false"`,
+    - have the bot try to pin every batch message
+- `clean_behind: "true" or "false"`
+    - have the bot try to delete their own messages
+    - does not apply to batch messages
+
+_The user issuing the command must have administrative rights in the chat._
+
+__Any chat but a channel__:
+
+```
+command  | argument
+---------+------------------------------------------
+/set     | optional argument after line break
+         | <":"-separated key-value pairs>            
+---------+------------------------------------------
+example  |  /set 
+         |  batch_size: 10
+         |  batch_at: 0800, 1200
+         |  webview: true >
+---------+------------------------------------------
+response | with no argument: list of settings
+         | with argument: error or success message
+---------+------------------------------------------
+```
+__Channels__:
+
+_Both the user performing this command and the bot must be admin in the target channel. The command may be issued from any chat with the bot. For a better experience it is recommended to give bot the permission to edit and pin messages._
+
+```
+command  | argument
+---------+---------------------------------------------
+/setchan | <line break + ":"-separated key-value pairs 
+---------+--------------+------------------------------
+example  |  /setchan -25154554
+         |  batch_every: 9000
+         |  pin: true
+         |  webview: true
+---------+---------------------------------------------
+returns  | error or success message                                   
+---------+---------------------------------------------
+```
+
+### List subscribed to web feeds
+
+__Any chat but a channel__:
+
+```
+command   | argument
+----------+---------
+/list, /l | none    
+----------+---------
+example   | /l      
+----------+-----------------------------
+response  | list of #s associated with   
+          | each subscripbed to web feed 
+----------------------------------------
+```
+
+__Channels__:
+
+```
+command   | argument
+----------+---------------------------------
+/listchan, /lchan | <chat_id of the channel>    
+----------+---------------------------------
+example   | /lchan -25154554
+----------+---------------------------------
+response  | list of #s associated with   
+          | each subscripbed to web feed 
+--------------------------------------------
+```
+
+### Show information about a subscribed to feed
+
+```
+command      | argument
+-------------+------------------------------------------------
+/feed, /f    | <# of the target feed, or full url >           
+-------------+------------------------------------------------
+example      | /feed 1, /feed https://www.phoronix.com/rss.php
+-------------+------------------------------------------------
+response     | information about the target feed              
+-------------+------------------------------------------------
+```
+### Fetching fresh items
+
+```
+command  | argument
+---------+----------------------------------------------------------
+/fresh   | <# of days representing how old the items can be at most 
+---------+----------------------------------------------------------
+example  | /fresh 1 
+---------+----------------------------------------------------------
+response | all at most #-old items collected from
+         |  all feeds the chat is subscribed to
+--------------------------------------------------------------------
+```
+
+### Displaying items from a single feed
+
+```
+command     | argument
+------------+--------------------------------------------
+/items, /i  | <# or full url of the target of days 
+            |   representing the max "age" of the items
+------------+--------------------------------------------
+example     | /items 1
+            | /i https://www.phoronix.com/rss.php
+------------+---------------------------------------------
+response    | all the items available from the target feed
+----------------------------------------------------------
+```
+### Miscellaneous
+
+- /pause, /p: Suspend notification to the chat
+- /pausechan `<chat_id>`: Like the previous one but for channels
+- /resume:  Whether the bot is allowed to send notification messages to the chat.
+- /resumechan `<chat_id>`: like the previous one but for channels
+- /purge (chat admins only): Make the database forget entirely about the chat
+- /purgechan `<chat_id>` (chat admins only): Make the database forget entirely about the channel
+- /reset (chat admins only): Set the chat's settings to the defaults
+- /resetchan `<chat_id>` (chat admins only) `<channel_id>`: Set the channels's settings to the defaults
+- /search, /se `<space-separated keywords>`: Search for keywords in all items in all feeds the current chat is subscribed to. 
+    - example: `/se cheap cloud host`
+- /unsub (chat admins only) `<list of 1-space-separated #s or full url addresses>`
+    - unsubscribe from all the feeds passed as argument, if indeed they exits
+    - examples: `/u 1 2 3`, `/unsub https://www.compositional.fm/rss https://www.blabla.org/feed`
+- /unsubchan `<chat_id>` (chat admins only) `<channel id> + <list of 1-space-separated # or full urls>`: like the previous one but for channels 

ChangeLog.md

@@ -1,5 +1,5 @@
 # feedfarer
-A fast, efficient network app for subscribing Telegram chats to web feeds.
+A fast, efficient network app for subscribing Telegram chats to web feeds, using 0 "Telegram SDK-style" framework or dependency.
 
 ## What this package provides
 - a Telegram bot able to post updates to any web feed (Atom or RSS) feed a chat is subscribed to; the bot is also replies directly to commands for consuming feeds at one's favorite pace
@@ -23,6 +23,8 @@ All chats types are supported:
 
 The bot does not require any permission; it just need to be a member of the group to which it posts updates.
 
+For the exhaustive list of commands, see this [document](https://github.com/why-not-try-calmer/feedfarer2/blob/dev/COMMANDS.md).
+
 __Getting started__:
 
 1. Start a chat with the bot (1-1 chat) or invite it to any chat (group or private). The bot listens only to messages using commands defined for it.
@@ -115,4 +117,7 @@ STARTING_FEEDS=https://blog.system76.com/rss,https://www.reddit.com/r/pop_os.rss
 TELEGRAM_TOKEN=1202309djkj@@kskdjkcjkjxkj
 WEBHOOK_URL=https://mydomain.org/path/to/wehbook
 
-```
+```
+
+## Support this bot
+I am hosting the bot on my own. If you want to [pay me a coffee or a beer](https://paypal.me/WhyNotTryCalmer) to show your appreciation, that will help me maintain the code and pay the electricity bills...

README.md

@@ -17,7 +17,6 @@ license-file:   LICENSE
 build-type:     Simple
 extra-source-files:
     README.md
-    ChangeLog.md
 
 source-repository head
   type: git

app/.github/workflows/deploy.yaml

@@ -8,7 +8,6 @@ copyright:           "2021 Adrien Glauser"
 
 extra-source-files:
 - README.md
-- ChangeLog.md
 
 description:         Please see the README on GitHub at <https://github.com/githubuser/feedfarer#readme>
 

feedfarer.cabal

@@ -14,7 +14,7 @@ import Database (getFreshPipe, initMongoCredsFrom)
 import Jobs
 import Network.Wai
 import Network.Wai.Handler.Warp
-import Requests (replyThenClean)
+import Requests (reply)
 import Responses
 import Servant
 import System.Environment (getEnvironment)
@@ -39,7 +39,7 @@ server = root :<|> handleWebhook    where
         else    liftIO $ putStrLn "Secrets do not match."
         where
             tok = bot_token . tg_config
-            finishWith env cid err = replyThenClean (tok env) cid (PlainReply $ renderUserError err) (postjobs env)
+            finishWith env cid err = reply (tok env) cid (ServiceReply $ renderUserError err) (postjobs env)
             handle upd env = case message upd of
                 Nothing -> liftIO $ putStrLn "Failed to parse message"
                 Just msg ->
@@ -53,7 +53,7 @@ server = root :<|> handleWebhook    where
                                 Left err -> finishWith env cid err
                                 Right action -> evalTgAct uid action cid >>= \case
                                     Left err -> finishWith env cid err
-                                    Right r -> replyThenClean (tok env) cid r (postjobs env)
+                                    Right r -> reply (tok env) cid r (postjobs env)
 
     root :: MonadIO m => App m ServerResponse
     root = pure $ RespOk "ok" "testing"