mork-parser 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bed8800b4f506dcf34185682e440188ebc60a0d40afb6709b3de078e8d8cd35d
+  data.tar.gz: 2efabe69f325398a9982d9eabcb44cf88898f581245ce3d4863f07b5a2ad815d
+SHA512:
+  metadata.gz: 25845a115fbed77f346cd14cf14d9c2be85b03bb73d95b130dea0a28c4c18ff3694b6e1fab0ef6708bbf2512b4e1bf1500260b72fe42d103de75d1512c1e4ac0
+  data.tar.gz: 12cb8b831ac111de6848008c5e84183a4651d6e197dfd07d4b092badf74aa37083b12b34d959471696958e2043ba51d70c34eb1222aefa8ad79ee911409856b4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Joe Yates
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Mork
+
+[![Build Status](https://github.com/joeyates/imap-backup/actions/workflows/main.yml/badge.svg)][CI Status]
+![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/joeyates/0ad88e9ac5abded0a579daf09b3dbc8f/raw/coverage.json)
+
+[CI Status]: https://github.com/joeyates/imap-backup/actions/workflows/main.yml
+
+Mozilla Thunderbird uses the [Mork database format](https://en.wikipedia.org/wiki/Mork_%28file_format%29) for its folder indexes.
+
+This library reads in a Mork file and produces a `Mork::Data` instance.
+
+This provides:
+
+* `tables` - The top-level tables,
+* `rows` - The top-level rows (i.e. rows not contained in tables).
+
+## Usage
+
+```ruby
+require "mork/parser"
+
+parser = Mork::Parser.new
+content = File.read("MyFolder.msf")
+raw = parser.parse(content)
+data = raw.data
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies.
+Then, run `rake spec` to run the tests.
+
+To release a new version, update the version number in `version.rb`,
+and then run `rake release`, which will create a git tag for the version,
+push git commits and the created tag,
+and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joeyates/mork.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the [code of conduct](https://github.com/joeyates/mork/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mork project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joeyates/mork/blob/main/CODE_OF_CONDUCT.md).

data/lib/mork/data.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mork
+  # The pure data extracted from a Mork file
+  class Data
+    attr_reader :rows
+    attr_reader :tables
+
+    def initialize(rows:, tables:)
+      @rows = rows
+      @tables = tables
+    end
+  end
+end

data/lib/mork/lexer.rb

@@ -0,0 +1,315 @@
+#--
+# DO NOT MODIFY!!!!
+# This file is automatically generated by rex 1.0.7
+# from lexical definition file "parser/mork.rex".
+#++
+
+require 'racc/parser'
+# mork
+# lexical definition for Mork files
+#
+# Generate Ruby lexer:
+# $ rex parser/mork.rex --output-file lib/mork/lexer.rb
+
+class Mork::Lexer < Racc::Parser
+      require 'strscan'
+
+      class ScanError < StandardError ; end
+
+      attr_reader   :lineno
+      attr_reader   :filename
+      attr_accessor :state
+
+      def scan_setup(str)
+        @ss = StringScanner.new(str)
+        @lineno =  1
+        @state  = nil
+      end
+
+      def action
+        yield
+      end
+
+      def scan_str(str)
+        scan_setup(str)
+        do_parse
+      end
+      alias :scan :scan_str
+
+      def load_file( filename )
+        @filename = filename
+        File.open(filename, "r") do |f|
+          scan_setup(f.read)
+        end
+      end
+
+      def scan_file( filename )
+        load_file(filename)
+        do_parse
+      end
+
+
+        def next_token
+          return if @ss.eos?
+
+          # skips empty actions
+          until token = _next_token or @ss.eos?; end
+          token
+        end
+
+        def _next_token
+          text = @ss.peek(1)
+          @lineno  +=  1  if text == "\n"
+          token = case @state
+            when nil
+          case
+                  when (text = @ss.scan(/\/\/\s<!--\s<mdb:mork:z.*\n/))
+                     action { @stack = [];            [:magic, text] }
+
+                  when (text = @ss.scan(/\/\//))
+                     action { @state = :COMMENT;      [:comment_in, text] }
+
+                  when (text = @ss.scan(/\n/))
+                     action { }
+
+                  when (text = @ss.scan(/</))
+                     action { @stack.push(@state); @state = :DICTIONARY;   [:dictionary_in, text] }
+
+                  when (text = @ss.scan(/\[/))
+                     action { @stack.push(@state); @state = :ROW; [:row_in, text] }
+
+                  when (text = @ss.scan(/\{[\-A-Z0-9]+(:[^\s]+\s)?/))
+                     action { @stack.push(@state); @state = :TABLE; [:table_in, text] }
+
+                  when (text = @ss.scan(/@\$\${[0-9A-F]+{@/))
+                     action { @state = :GROUP;       [:group_in, text] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+            when :COMMENT
+          case
+                  when (text = @ss.scan(/\n/))
+                     action { @state = @stack.pop;    [:comment_out, text] }
+
+                  when (text = @ss.scan(/.*/))
+                     action {                         [:comment_text, text] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+            when :DICTIONARY
+          case
+                  when (text = @ss.scan(/\s+/))
+                     action { }
+
+                  when (text = @ss.scan(/>/))
+                     action { @state = @stack.pop;    [:dictionary_out, text] }
+
+                  when (text = @ss.scan(/\/\//))
+                     action { @stack.push(@state); @state = :COMMENT;      [:comment_in, text] }
+
+                  when (text = @ss.scan(/</))
+                     action { @state = :META;         [:meta_in, text] }
+
+                  when (text = @ss.scan(/\(/))
+                     action { @state = :ALIAS;        [:alias_in, text] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+            when :ALIAS
+          case
+                  when (text = @ss.scan(/\)/))
+                     action { @state = :DICTIONARY;   [:alias_out, text] }
+
+                  when (text = @ss.scan(/[0-9A-F]+(?==|$)/))
+                     action { @state = :ALIAS_VALUE;  [:alias_key, text] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+            when :ALIAS_VALUE
+          case
+                  when (text = @ss.scan(/\n/))
+                     action { }
+
+                  when (text = @ss.scan(/\s+/))
+                     action { }
+
+                  when (text = @ss.scan(/=(?=\))/))
+                     action { @state = :ALIAS;        [:alias_value, nil] }
+
+                  when (text = @ss.scan(/=(\\\)|[^\)])+/))
+                     action { @state = :ALIAS; value = text[1..]; [:alias_value, value] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+            when :META
+          case
+                  when (text = @ss.scan(/\s+/))
+                     action { }
+
+                  when (text = @ss.scan(/>/))
+                     action { @state = :DICTIONARY;   [:meta_out, text] }
+
+                  when (text = @ss.scan(/\(/))
+                     action { @state = :META_ALIAS;   [:meta_alias_in, text] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+            when :META_ALIAS
+          case
+                  when (text = @ss.scan(/\)/))
+                     action { @state = :META;         [:meta_alias_out, text] }
+
+                  when (text = @ss.scan(/[^=]+=[^\)]+/))
+                     action {                         [:meta_alias, text] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+            when :ROW
+          case
+                  when (text = @ss.scan(/[\-A-Z0-9]+(:[^\(]+)?/))
+                     action { @state = :CELLS;  [:row_mid, text] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+            when :CELLS
+          case
+                  when (text = @ss.scan(/\s+/))
+                     action { }
+
+                  when (text = @ss.scan(/\n/))
+                     action { }
+
+                  when (text = @ss.scan(/\]/))
+                     action { @state = @stack.pop;    [:row_out, text] }
+
+                  when (text = @ss.scan(/\(/))
+                     action { @state = :CELL;         [:cell_in, text] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+            when :CELL
+          case
+                  when (text = @ss.scan(/\)/))
+                     action { @state = :CELLS;        [:cell_out, text] }
+
+                  when (text = @ss.scan(/\^[0-9A-F]+=[^\)]*/))
+                     action {                   [:cell_value, text] }
+
+                  when (text = @ss.scan(/\^[0-9A-F]+\^[0-9A-F]+/))
+                     action {               [:cell_value, text] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+            when :TABLE
+          case
+                  when (text = @ss.scan(/\s+/))
+                     action { }
+
+                  when (text = @ss.scan(/\}/))
+                     action { @state = @stack.pop;    [:table_out, text] }
+
+                  when (text = @ss.scan(/\{/))
+                     action { @state = :META_TABLE;   [:meta_table_in, text] }
+
+                  when (text = @ss.scan(/\[/))
+                     action { @stack.push(@state); @state = :ROW; [:row_in, text] }
+
+                  when (text = @ss.scan(/\-[A-Z0-9]+\s*/))
+                     action {                      [:row_delete, text] }
+
+                  when (text = @ss.scan(/[A-Z0-9]+(:[^\s]+\s)?/))
+                     action {                  [:table_row_ref, text] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+            when :META_TABLE
+          case
+                  when (text = @ss.scan(/\}/))
+                     action { @state = :TABLE;         [:meta_table_out, text] }
+
+                  when (text = @ss.scan(/\([^\)]+\)/))
+                     action {                          [:meta_table_cell, text] }
+
+                  when (text = @ss.scan(/[A-Z0-9]+(:[^\s]+\s)?/))
+                     action {                  [:meta_table_row_ref, text] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+            when :GROUP
+          case
+                  when (text = @ss.scan(/\n/))
+                     action { }
+
+                  when (text = @ss.scan(/@\$\$}[0-9A-F]+}@/))
+                     action { @state = nil;          [:group_out, text] }
+
+                  when (text = @ss.scan(/</))
+                     action { @stack.push(@state); @state = :DICTIONARY;   [:dictionary_in, text] }
+
+                  when (text = @ss.scan(/\[/))
+                     action { @stack.push(@state); @state = :ROW; [:row_in, text] }
+
+                  when (text = @ss.scan(/\{[\-A-Z0-9]+(:[^\s]+\s)?/))
+                     action { @stack.push(@state); @state = :TABLE; [:table_in, text] }
+
+          
+          else
+            text = @ss.string[@ss.pos .. -1]
+            raise  ScanError, "can not match: '" + text + "'"
+          end  # if
+
+        else
+          raise  ScanError, "undefined state: '" + state.to_s + "'"
+        end  # case state
+          token
+        end  # def _next_token
+
+end # class