pr2gpx 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 David Tischler
+
+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,70 @@
+pr2gpx
+======
+
+Converts Winlink position reports sent or received with Airmail into GPX tracks or waypoints.
+
+It understands:
+- sent position reports (Window->Winlink-2000->Position Report)
+- reports requested for specific stations (Window->Winlink-2000->Position Request)
+- lists of nearby stations (Window->Catalogs->WL2K->Global->WL2K_USERS->WL2K_NEARBY)
+
+pr2gpx scans a directory for files containing position reports in various formats. It can filter them to include only stations with a given callsign, and limit the results to the last N reports per station.
+
+The output is either one track for each station, a list of waypoints for every position report, or both.
+
+This can either be saved into a single file containing everything, or it can be split into one file for each station.
+
+
+Installing
+----------
+
+First make sure you have Ruby >= 1.9 running.
+
+Then install pr2gpx:
+
+    gem install pr2gpx
+
+
+Using
+-----
+
+    pr2gpx --help
+
+Displays information about the usage.
+
+
+	pr2gpx --input c:\ProgramData\Airmail\Outbox
+
+Writes all position reports in the outbox to STDOUT.
+
+
+	pr2gpx --input c:\ProgramData\Airmail\Inbox --last 1 --callsign CALL1,CALL2,CALL3 --output C:\ProgramData\opencpn\layers\positions.gpx
+
+Writes the most recent position report of CALL1, CALL2 and CALL3 into positions.gpx in C:\ProgramData\opencpn\layers.
+
+
+	pr2gpx --input c:\ProgramData\Airmail\Inbox --last 10 --callsign CALL1,CALL2,CALL3 --output C:\ProgramData\opencpn\layers --split
+
+Writes the 10 most recent position reports of CALL1, CALL2 and CALL3 into PR_CALL1.gpx, PR_CALL2.gpx and PR_CALL3.gpx in C:\ProgramData\opencpn\layers.
+
+
+Developing
+----------
+
+Source: http://github.com/tischdla/pr2gpx
+
+
+Run tests:
+
+	rake test
+
+
+Create gem package:
+
+	rake package
+
+
+Copyright
+---------
+
+Copyright (c) 2012 David Tischler, licensed under the MIT License.

data/bin/pr2gpx

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+require 'pr2gpx.rb'

data/lib/pr2gpx.rb

@@ -0,0 +1,124 @@
+require 'nokogiri'
+require 'nokogiri/xml'
+require 'pr2gpx/parser'
+require 'pr2gpx/options'
+
+def enumerate_files search_path
+  Enumerator.new do |e|
+    Dir
+      .glob(search_path)
+      .each do |filename|
+        File.open filename do |file|
+          e.yield file.read()
+      end
+    end
+  end
+end
+
+def load_data content_enum, filter
+  reportParser = ReportParser.new
+  stations = Hash.new
+
+  content_enum.each do |content|
+    reports = reportParser.parse(content)
+    if reports
+      reports.each do |report|
+        if filter.include? report
+          stations[report.callsign] = Hash.new unless stations.has_key? report.callsign
+          stations[report.callsign][report.date] = report unless stations[report.callsign].has_key? report.date
+        end
+      end
+    end
+  end
+
+  stations
+end
+
+def filter_data! stations, last
+  stations.each do |callsign, reports|
+    stations[callsign] = reports.values
+      .sort { |report1, report2| report1.date <=> report2.date }
+    
+    stations[callsign] = stations[callsign]
+      .reverse
+      .take(last)
+      .reverse if last
+  end
+end
+
+def build_gpx stations, create_trk, create_wpt
+  builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+    xml.gpx(xmlns: 'http://www.topografix.com/GPX/1/1') do
+      if create_trk
+        stations.each do |callsign, reports|
+          xml.trk do
+            xml.name callsign
+            xml.trkseg do
+              reports.each do |report|
+                xml.send('trkpt', lat: report.position.latitude, lon: report.position.longitude) do
+                  xml.name report.comment
+                  xml.time report.date.strftime('%FT%TZ')
+                end
+              end
+            end
+          end
+        end
+      end
+      if create_wpt
+        stations.each do |callsign, reports|
+          last = reports.last
+          reports.each do |report|
+            xml.send('wpt', lat: report.position.latitude, lon: report.position.longitude) do
+              xml.name report.callsign
+              xml.desc report.comment
+              xml.time report.date.strftime('%FT%TZ')
+              xml.type 'WPT'
+              xml.sym report == last ? 'triangle' : 'circle'
+            end
+          end
+        end
+      end
+    end
+  end
+  builder.to_xml
+end
+
+def write_gpx filename, gpx
+  File.open filename, 'w:UTF-8' do |file|
+    file.write gpx
+  end
+end
+
+options = parse_options ARGV
+exit if not options
+
+options[:input].gsub!('\\', '/')
+options[:output].gsub!('\\', '/') if options[:output]
+
+search_path = "#{options[:input]}/#{options[:recurse] ? '**/' : ''}*.*"
+$stderr.puts "Searching #{search_path}" if $verbose
+
+filter = ReportFilter.new options[:callsign]
+
+stations = load_data(enumerate_files(search_path), filter)
+filter_data! stations, options[:last]
+
+if options[:split]
+  stations.each do |callsign, reports|
+    gpx = build_gpx({ callsign => reports }, options[:create_trk], options[:create_wpt])
+
+    if options[:output] then
+      write_gpx "#{options[:output]}/#{options[:prefix]}#{callsign}.gpx", gpx
+    else
+      puts gpx
+    end
+  end
+else
+  gpx = build_gpx(stations, options[:create_trk], options[:create_wpt])
+
+  if options[:output] then
+    write_gpx options[:output], gpx
+  else
+    puts gpx
+  end
+end

data/lib/pr2gpx/options.rb

@@ -0,0 +1,98 @@
+require 'optparse'
+
+def parse_options argv
+  options = {}
+  mandatory = [:input]
+
+  def set_option options, name
+    ->(options, name, value) { options[name] = value }.curry.(options, name)
+  end
+
+  OptionParser.new do |o|
+    options[:input] = nil
+    o.on '-i', '--input PATH',
+      'Specifies the path to be searched for files containing position reports.',
+      set_option(options, :input)
+
+    options[:recurse] = false
+    o.on '-r', '--recurse',
+      'Enables recursive searching.' do
+        options[:recurse] = true
+      end
+
+    options[:output] = nil
+    o.on '-o', '--output [PATH]',
+      'Specifies the file or directory (when using --split) to write to. Default is STDOUT.',
+      set_option(options, :output)
+
+    options[:split] = false
+    o.on '-s', '--split',
+      'Creates one GPX document per station. If --output is specified, it is interpreted as a directory, and one file is created per station, named [PREFIX][STATION].gpx.' do |value|
+      options[:split] = value
+    end
+
+    options[:prefix] = 'PR_'
+    o.on '-p', '--prefix [PREFIX]',
+      'Specifies the prefix to be used when using --split, default is \'PR_\'.',
+      set_option(options, :output)
+
+    options[:callsign] = nil
+    o.on '-c', '--callsign [CALLSIGN[,CALLSIGN]]', Array,
+      'Processes only the stations with the given callsigns.',
+      set_option(options, :callsign)
+
+    options[:last] = nil
+    o.on '-l', '--last [n]', Integer,
+      'Limits the result to the last N entries for each station.',
+      set_option(options, :last)
+
+    options[:help] = false
+    o.on '-h', '--help',
+      'Displays this screen.' do
+      options[:help] = true
+    end
+    
+    options[:create_trk] = options[:create_wpt] = true
+    o.on '-f', '--format FORMAT[,FORMAT]', Array,
+      'Selects one or more output formats. Supported values are \'TRK\', \'WPT\'.' do |values|
+      values.each do |value|
+        options[:create_trk] = options[:create_wpt] = false
+        case(value)
+          when 'TRK' then options[:create_trk] = true
+          when 'WPT' then options[:create_wpt] = true
+          else raise OptionParser::InvalidOption.new value
+        end
+      end
+    end
+    
+    $verbose = false
+    o.on '-v', '--verbose',
+      'Turns on verbose mode.' do |value|
+      $verbose = value
+    end
+
+    begin
+      o.parse! argv
+
+      if not options[:help]
+        missing = mandatory.select { |param| options[param].nil? }
+        if not missing.empty?
+          puts "Missing options: #{missing.join(', ')}"
+          puts
+          options[:help] = true
+        end
+      end
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+      puts $!.to_s
+      puts
+      options[:help] = true
+    end
+
+    if options[:help]
+      puts o
+      return nil
+    end
+  end
+
+  options
+end

data/lib/pr2gpx/parser.rb

@@ -0,0 +1,119 @@
+require 'date'
+
+PositionReport = Struct.new "PositionReport", :callsign, :date, :position, :comment
+
+class Position
+  attr_reader :latitude, :longitude 
+
+  def initialize latitude, longitude
+    @latitude = parse_angle latitude
+    @longitude = parse_angle longitude
+  end
+
+  def == other
+    self.latitude == other.latitude and
+    self.longitude == other.longitude 
+  end
+
+  def parse_angle value
+    if /(?<degrees>\d+)-(?<minutes>\d+\.\d+)(?<sign>[NSWE])/ =~ value
+      (degrees.to_f + minutes.to_f / 60) * ((sign == 'S' or sign == 'W') ? -1 : 1)
+    end
+  end
+end
+
+class ReportParser
+  def initialize
+    @parsers = [NearbyStationsParser.new, ReportsListParser.new, OutboundReportParser.new]
+  end
+
+  def parse input
+    parser = @parsers.find { |parser| parser.can_parse? input }
+
+    if parser
+      parser.parse input
+    else
+      nil
+    end
+  end
+end
+
+class OutboundReportParser
+  def can_parse? input
+    /Subject: POSITION REPORT/ =~ input
+  end
+
+  def parse input
+    Enumerator.new do |e|
+      if %r{
+        (X-From:[ ](?<callsign>[^\n]*))\n
+        .*
+        (TIME:[ ](?<year>\d+)/(?<month>\d+)/(?<day>\d+)[ ](?<hour>\d+):(?<minute>\d+))\n
+        (LATITUDE:[ ](?<latitude>[^\n]*))\n
+        (LONGITUDE:[ ](?<longitude>[^\n]*))\n
+        (COMMENT:[ ](?<comment>[^\n]*))}xm =~ input
+      then
+        e.yield PositionReport.new callsign,
+                                   DateTime.new(year.to_i, month.to_i, day.to_i, hour.to_i, minute.to_i, 0),
+                                   Position.new(latitude, longitude),
+                                   comment
+      end
+    end
+  end
+end
+
+class ReportsListParser
+  def can_parse? input
+    /Automated Reply Message from Winlink 2000 Position Report Processor/ =~ input
+  end
+
+  def parse input
+    Enumerator.new do |e|
+      input.scan %r{
+        \n\n(?<callsign>\w*)[ ]
+        (?<year>\d+)/(?<month>\d+)/(?<day>\d+)[ ](?<hour>\d+):(?<minute>\d+)[ ]
+        (?<latitude>[^\n]*)[ ]
+        (?<longitude>[^\n]*)\n
+        Comment:[ ](?<comment>[^\n]*)
+      }xm do |callsign, year, month, day, hour, minute, latitude, longitude, comment|
+        e.yield PositionReport.new callsign,
+                                   DateTime.new(year.to_i, month.to_i, day.to_i, hour.to_i, minute.to_i, 0),
+                                   Position.new(latitude, longitude),
+                                   comment
+      end
+    end
+  end
+end
+
+class NearbyStationsParser
+  def can_parse? input
+    /List of users nearby/ =~ input
+  end
+
+  def parse input
+    Enumerator.new do |e|
+      input.scan %r{^
+        (?<callsign>[^ ]*)[ ].*[ ][ ][ ]
+        (?<latitude>[^ ]*)[ ]
+        (?<longitude>[^ ]*)[ ][ ]
+        (?<year>\d+)/(?<month>\d+)/(?<day>\d+)[ ](?<hour>\d+):(?<minute>\d+)[ ][ ]
+        (?<comment>[^\n]*)
+      }x do |callsign, latitude, longitude, year, month, day, hour, minute, comment|
+        e.yield PositionReport.new callsign,
+                                   DateTime.new(year.to_i, month.to_i, day.to_i, hour.to_i, minute.to_i, 0),
+                                   Position.new(latitude, longitude),
+                                   comment
+      end
+    end
+  end
+end
+
+class ReportFilter
+  def initialize callsigns
+    @callsigns = callsigns
+  end
+
+  def include? report
+    not @callsigns or @callsigns.include? report.callsign
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: pr2gpx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- David Tischler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+description: ! 'Converts Winlink position reports sent or received with Airmail into
+  GPX tracks or waypoints.
+
+'
+email: david.tischler@gmx.at
+executables:
+- pr2gpx
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pr2gpx/options.rb
+- lib/pr2gpx/parser.rb
+- lib/pr2gpx.rb
+- bin/pr2gpx
+- MIT-LICENSE
+- README.md
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: pr2gpx
+test_files: []