imap_mogura 0.1.1.pre.dev → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63948c26de8c10fedd38588189779fd6eeee167f3ab8fe54be42ab3ae37eac76
-  data.tar.gz: 1b86c8501895ea103f4627a34cb3057eda23f42d0722aeceb2d6ea1630ed7472
+  metadata.gz: ccc5914a45fede7ba28883f41ef95bba9e0f426c7a4a563a926dd7dcbb3c17f1
+  data.tar.gz: '069f651ef1fee7cb2f5a5f3547a7c13eca03646c46f47a3d298ba3b21a8db6a8'
 SHA512:
-  metadata.gz: 902ce048023623971dd7c26e5512888eea1275e1160895f8fa0d6a36d91386f76e8f5d3f3a3b2cef42709b0d76d77bd08cf8c4381ea03d4dbaa62a9691b25b82
-  data.tar.gz: 72055ee14145ec3a81ccfe02f50bc903f060368e933fbce27e63f0d45ffdd5f0ec1829ffa054ec4f0179d77bec9f4948c4dc372d408943f1332f7973b81e12ef
+  metadata.gz: 0cfac9d2da8aca0e2d8ec59775699ebea6038d70e3308522a067eccb5b80150116200796071ac23713af8f4a3b4224b8fdc940e67601f1f00ee4c1599fe211ec
+  data.tar.gz: 7b89c3160fd326abdac3ed32d019adbfe18870a7aba4159411e974cac4e408f9aead8f52f28f187d245c9bb60ce0f6c166a273ac5ac4f1e5c292f891dbaaf2f7

data/README.md

@@ -4,17 +4,12 @@ A mail filtering tool for IMAP.
 
 ## Installation
 
-Check out this repository first and enter the directory.
+To install this gem, just run as following. You can get the gem from [RubyGems.org](https://rubygems.org/).
 
 ```console
-$ git clone https://github.com/yskuniv/imap_mogura.git
-$ cd imap_mogura/
+$ gem install imap_mogura
 ```
 
-Install this gem and add to the application's Gemfile by executing:
-
-    $ bundle install
-
 ## Usage
 
 Create `rules.yml` and write rules like following.
@@ -38,22 +33,21 @@ rules:
       subject: "i'm trash-like email!!"
 ```
 
-As following, `start` command will start monitoring RECENT mails on "INBOX". If a mail is coming
- and it's RECENT, it will be filtered.
+Running `mogura start` command will start monitoring RECENT mails coming to "INBOX". If a mail with RECENT flag is coming to the mailbox, it will be filtered.
 
 ```console
 $ mogura start <host> -u <user> --password-base64=<password-base64-encoded> -c rules.yml -b INBOX
 ```
 
-You can specify a mailbox which to be monitored by `-b` option.
+You can specify the mailbox by `-b` option.
 
-If you want to just filter mails on a specific mailbox, run the `filter` command as following.
+If you want to just filter mails on the specific mailbox, use `mogura filter` command.
 
 ```console
 $ mogura filter <host> -u <user> --password-base64=<password-base64-encoded> -c rules.yml -b <mailbox>
 ```
 
-You can check your config by `check-config` command. It returns just OK if no errors in the config.
+You can check your config by `mogura check-config` command. It returns just OK if no errors in the config.
 
 ```console
 $ mogura check-config -c rules.yml

data/lib/imap_mogura/cli.rb

@@ -42,16 +42,15 @@ module ImapMogura
       create_directory = options[:create_directory]
       dry_run = options[:dry_run]
 
-      monitored_events = ["RECENT"]
       search_keys = ["RECENT", *(["UNSEEN"] if filter_unseen)]
 
-      with_all_preparation_ready(config_name, host, port, starttls, use_ssl,
-                                 auth_info: { auth_type: auth_type, user: user, password: password },
-                                 create_directory: create_directory,
-                                 dry_run: dry_run) do |imap_handler, rules|
+      with_preparation_ready(config_name, host, port, starttls, use_ssl,
+                             auth_info: { auth_type: auth_type, user: user, password: password },
+                             create_directory: create_directory,
+                             dry_run: dry_run) do |imap_handler, rules|
         warn "* start monitoring recent mails in \"#{target_mailbox}\""
 
-        imap_handler.monitor_events(target_mailbox, monitored_events) do
+        monitor_recents_on_mailbox(imap_handler, target_mailbox) do
           imap_handler.find_and_handle_mails(target_mailbox, search_keys) do |message_id|
             warn "mail (id = #{message_id} on \"#{target_mailbox}\") is recent"
 
@@ -86,24 +85,23 @@ module ImapMogura
       all_mailbox = options[:all_mailbox]
       exclude_mailboxes = options[:exclude_mailboxes]
       target_mailbox = options[:target_mailbox] unless all_mailbox
-
-      raise CustomOptionError, "--all-mailbox (-a) or --target-mailbox (-b) is required" if !all_mailbox && target_mailbox.nil?
-
       filter_only_unseen = options[:filter_only_unseen]
       create_directory = options[:create_directory]
       dry_run = options[:dry_run]
 
+      raise CustomOptionError, "--all-mailbox (-a) or --target-mailbox (-b) is required" if !all_mailbox && target_mailbox.nil?
+
       search_keys = if filter_only_unseen
                       ["UNSEEN"]
                     else
                       ["ALL"]
                     end
 
-      with_all_preparation_ready(config_name, host, port, starttls, use_ssl,
-                                 auth_info: { auth_type: auth_type, user: user, password: password },
-                                 excluded_mailboxes: exclude_mailboxes,
-                                 create_directory: create_directory,
-                                 dry_run: dry_run) do |imap_handler, rules, options|
+      with_preparation_ready(config_name, host, port, starttls, use_ssl,
+                             auth_info: { auth_type: auth_type, user: user, password: password },
+                             excluded_mailboxes: exclude_mailboxes,
+                             create_directory: create_directory,
+                             dry_run: dry_run) do |imap_handler, rules, options|
         if all_mailbox
           excluded_mailboxes = options[:excluded_mailboxes]
 
@@ -152,13 +150,14 @@ module ImapMogura
 
     private
 
-    def with_all_preparation_ready(config_name,
-                                   host, port,
-                                   starttls, use_ssl, certs: nil, verify: true,
-                                   auth_info: nil,
-                                   excluded_mailboxes: [],
-                                   create_directory: true,
-                                   dry_run: false, &block)
+    def with_preparation_ready(config_name,
+                               host, port,
+                               starttls, use_ssl, certs: nil, verify: true,
+                               auth_info: nil,
+                               excluded_mailboxes: [],
+                               create_directory: true,
+                               dry_run: false,
+                               &block)
       _, rules = load_and_handle_config(config_name)
 
       warn "* connecting the server #{host}:#{port}..."
@@ -207,29 +206,40 @@ module ImapMogura
       end
     end
 
+    def monitor_recents_on_mailbox(imap_handler, mailbox, retry_count = 0, &block)
+      imap_handler.monitor_events(mailbox, ["RECENT"], &block)
+    rescue IMAPHandler::MailFetchError => e
+      handle_mail_fetch_error_and_preprocess_retrying(e, retry_count)
+
+      warn "retry monitoring mails on #{e.mailbox}..."
+
+      # retry monitor recents on mailbox itself with retry count to be incremented
+      monitor_recents_on_mailbox(imap_handler, mailbox, retry_count + 1)
+    end
+
     def filter_mails(imap_handler, rules, mailbox, search_keys = ["ALL"], retry_count = 0, dry_run: false)
       imap_handler.find_and_handle_mails(mailbox, search_keys) do |message_id|
         filter_mail(imap_handler, rules, mailbox, message_id, dry_run: dry_run)
       end
     rescue IMAPHandler::MailFetchError => e
-      warn "failed to fetch mail (id = #{e.message_id} on mailbox #{e.mailbox}): #{e.bad_response_error_message}"
+      handle_mail_fetch_error_and_preprocess_retrying(e, retry_count)
 
-      # if retry_count is over the threshold, terminate processing
-      unless retry_count < 3
-        warn "retry count is over the threshold, stop processing"
+      warn "retry filtering all mails on #{e.mailbox}"
 
-        return
-      end
+      # retry filter all mails itself with retry count to be incremented
+      filter_mails(imap_handler, rules, mailbox, search_keys, retry_count + 1, dry_run: dry_run)
+    end
+
+    def handle_mail_fetch_error_and_preprocess_retrying(error, retry_count)
+      warn "failed to fetch mail (id = #{error.message_id} on mailbox #{error.mailbox}): #{error.bad_response_error_message}"
+
+      # if retry_count is over the threshold, abort processing
+      raise Thor::Error, "retry count is over the threshold, stop processing" unless retry_count < 3
 
       warn "wait a moment..."
 
       # wait a moment...
       sleep 10
-
-      warn "retry filter all mails on #{e.mailbox}"
-
-      # retry filter all mails itself
-      filter_mails(imap_handler, rules, mailbox, search_keys, retry_count + 1, dry_run: dry_run)
     end
 
     def filter_mail(imap_handler, rules, mailbox, message_id, dry_run: false)

data/lib/imap_mogura/rules_parser/rule_elements.rb

@@ -35,7 +35,7 @@ module ImapMogura
 
   class FieldMatcher < RuleElement
     def initialize(regexp)
-      @regexp = /#{regexp}/ # FIXME: need to care about malicious regular expression injection
+      @regexp = Regexp.new(regexp)
 
       super()
     end

data/lib/imap_mogura/rules_parser.rb

@@ -64,6 +64,8 @@ module ImapMogura
         else
           GeneralFieldMatcher.new(k, rule[k])
         end
+      rescue RegexpError
+        raise ParseError, "illegal regular expression: #{rule[k].inspect}"
       end
 
       def parse_rule_list(rule_list)

data/lib/imap_mogura/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImapMogura
-  VERSION = "0.1.1.pre.dev"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imap_mogura
 version: !ruby/object:Gem::Version
-  version: 0.1.1.pre.dev
+  version: 0.2.0
 platform: ruby
 authors:
 - ysk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-18 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64