vpim 0.597 → 0.602

data/bin/reminder

@@ -0,0 +1,203 @@
+#!/usr/bin/env ruby
+
+$-w = true
+
+require 'ubygems' rescue "ignored"
+
+require 'getoptlong'
+require 'pp'
+require 'plist'
+
+require 'vpim/repo'
+
+$stdout.sync = true
+$stderr.sync = true
+
+HELP =<<EOF
+Usage: #{$0} [where]
+
+Shows events and todos occuring soon.
+
+By default, the Apple iCal v3 calendars are used, but if a location where
+.ics files is specified, any calendars found there will be used.
+
+Options
+  -h,--help        Print this helpful message.
+  -n,--days   N    How many of the next days are considered to be "soon", default
+                     is seven.
+  -v,--verbose     Print more information about upcoming events.
+EOF
+
+opt_debug = nil
+opt_verbose = nil
+opt_days  = 7
+
+opts = GetoptLong.new(
+  [ "--help",    "-h",   GetoptLong::NO_ARGUMENT ],
+  [ "--days",    "-n",   GetoptLong::REQUIRED_ARGUMENT ],
+  [ "--verbose", "-v",   GetoptLong::NO_ARGUMENT ],
+  [ "--debug",   "-d",   GetoptLong::NO_ARGUMENT ]
+)
+
+opts.each do |opt, arg|
+  case opt
+    when "--help" then
+      puts HELP
+      exit 0
+
+    when "--days" then
+      opt_days = arg.to_i
+
+    when "--verbose" then
+      opt_verbose = true
+
+    when "--debug" then
+      opt_verbose = true
+      opt_debug = true
+  end
+end
+
+calendars = []
+
+if ARGV.length > 0
+  Vpim::Repo::Directory.each(ARGV.first) do |cal|
+    calendars << cal
+  end
+else
+  Vpim::Repo::Ical3.each() do |cal|
+    calendars << cal
+  end
+end
+
+if opt_debug
+  pp ARGV
+  pp calendars
+end
+
+SECSPERDAY = (24 * 60 * 60)
+
+t0 = Time.new.to_a
+t0[0] = t0[1] = t0[2] = 0 # sec,min,hour = 0
+t0 = Time.local(*t0)
+t1 = t0 + opt_days * SECSPERDAY
+
+if opt_debug
+  puts "to: #{t0}"
+  puts "t1: #{t1}"
+end
+
+if opt_verbose
+  puts "Events in the next #{opt_days} days:"
+end
+
+# Collect all events, then all todos.
+all_events = []
+all_todos  = []
+
+calendars.each do |cal|
+  if opt_debug; puts cal.name; end
+
+  begin
+    cal.events.each do |e|
+      begin
+        if opt_debug; pp e; end
+        if e.occurs_in?(t0, t1)
+          if e.summary
+            all_events.push(e)
+          end
+        end
+      rescue
+        $stderr.puts "error in #{cal.name} (\"#{e.summary}\"): #{$!.to_s}"
+      end
+    end
+
+    all_todos.concat(cal.todos)
+  end
+end
+
+puts
+
+def start_of_first_occurence(t0, t1, e)
+  e.occurences.each_until(t1).each do |t|
+    # An event might start before t0, but end after it..., in which case
+    # we are still interested.
+    if (t + (e.duration || 0)) >= t0
+      return t
+    end
+  end
+  nil
+end
+
+all_events.sort! do |lhs, rhs|
+  start_of_first_occurence(t0, t1, lhs) <=> start_of_first_occurence(t0, t1, rhs)
+end
+
+all_events.each do |e|
+  puts "#{e.summary}:"
+
+  if opt_verbose
+    if e.description;   puts "  description=#{e.description}"; end
+    if e.comments;      puts "  comment=#{e.comments.first}"; end
+    if e.location;      puts "  location=#{e.location}"; end
+    if e.status;        puts "  status=#{e.status}"; end
+    if e.dtstart;       puts "  dtstart=#{e.dtstart}"; end
+    if e.duration;      puts "  duration=#{Vpim::Duration.new(e.duration).to_s}"; end
+  end
+
+  i = 1
+  e.occurences.each_until(t1).each do |t|
+    # An event might start before t0, but end after it..., in which case
+    # we are still interested.
+    dstr = ''
+    if e.duration
+      d = e.duration
+      dstr = " for #{Vpim::Duration.new(e.duration).to_s}"
+    end
+
+    if (t + (e.duration || 0)) >= t0
+      puts "  ##{i} on #{t}#{dstr}"
+      i += 1
+    end
+  end
+end
+
+=begin
+def fix_priority(vtodo)
+  p = vtodo.priority
+  if !p
+    p = 10
+
+end
+=end
+
+all_todos.sort! do |x,y|
+  x = x.priority
+  y = y.priority
+
+  # 0 means no priority, put these last, not first
+  x = 10 if x == 0
+  y = 10 if y == 0
+
+  x <=> y
+end
+
+priorities = [
+  'no importance',
+  'very important',
+  'very important',
+  'very important',
+  'important',
+  'important',
+  'important',
+  'not important',
+  'not important',
+  'not important'
+]
+
+all_todos.each do |e|
+  status = e.status || 'Todo'
+  if status != 'COMPLETED'
+    puts "#{status.capitalize}: #{e.summary}" #  (#{priorities[e.priority]})"
+  end
+end
+

data/bin/rrule

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+$-w = true
+$:.unshift File.dirname($0) + "/../lib"
+
+require 'vpim/rrule'
+require 'getoptlong'
+require 'parsedate'
+
+HELP =<<EOF
+Usage: #{$0} [options] rrule
+
+Options
+  -h,--help      Print this helpful message.
+  -t,--start     Start time for recurrence rule, defaults to current time.
+
+Examples:
+
+FREQ=DAILY;COUNT=10
+FREQ=DAILY;UNTIL=19971224T000000Z
+FREQ=DAILY;INTERVAL=2
+FREQ=DAILY;INTERVAL=10;COUNT=5
+
+Demonstrate DST time change:
+
+#{$0}  --start '2004-04-03 02:00' 'FREQ=daily;count=3'
+#{$0}  --start '2004-10-30 02:00' 'FREQ=daily;count=3'
+
+Note: In the US DST starts at 2AM, on the first Sunday of April, and reverts
+at 2AM on the last Sunday of October.
+
+EOF
+
+dtstart = Time.new
+
+opts = GetoptLong.new(
+  [ "--help",    "-h",   GetoptLong::NO_ARGUMENT ],
+  [ "--start",   "-t",   GetoptLong::REQUIRED_ARGUMENT]
+)
+
+opts.each do |opt, arg|
+  case opt
+    when "--help" then
+      puts HELP
+      exit 0
+
+    when "--start" then
+      date = ParseDate.parsedate(arg)
+      date.pop
+      date.pop
+      dtstart = Time.local(*date)
+  end
+end
+
+if ARGV.length < 1
+  puts "no rrule specified, try -h!\n"
+  exit 1
+end
+
+puts "Start: #{Vpim.encode_date_time(dtstart)}"
+
+ARGV.each do |rule|
+  rrule = Vpim::Rrule.new(dtstart, rule)
+
+  puts "Rule: #{rule}"
+
+  rrule.each_with_index do |t, count|
+    puts format("count=%3d %s", count, t.to_s)
+  end
+end
+

data/lib/vpim/property/common.rb

@@ -288,7 +288,7 @@ seq
           set_text_list('CATEGORIES', cats)
         end
 
-        # Set the comment, see Icalendar::Get::Common#comment.
+        # Set the comment, see Icalendar::Get::Common#comments.
         def comment(value)
           set_text 'COMMENT', value
         end

data/lib/vpim/repo.rb

@@ -0,0 +1,116 @@
+=begin
+  Copyright (C) 2008 Sam Roberts
+
+  This library is free software; you can redistribute it and/or modify it
+  under the same terms as the ruby language itself, see the file COPYING for
+  details.
+=end
+
+require 'vpim/icalendar'
+require 'vpim/duration'
+
+module Vpim
+  # A Repo is a representation of an event repository. Currently iCalv3
+  # repositories and directories containing .ics files are supported.
+  #
+  # TODO - should yield them if a block is given, or return
+  # an enumerable otherwise. Later.
+  module Repo
+    def self.somethings_from_file(something, file) #:nodoc:
+      somethings = []
+      begin
+        cals = Vpim::Icalendar.decode(File.open(file))
+
+        cals.each do |cal|
+          cal.send(something).each do |x|
+            somethings << x
+          end
+        end
+      end
+      somethings
+    end
+
+    def self.events_from_file(file) #:nodoc:
+      self.somethings_from_file("events", file)
+    end
+
+    def self.todos_from_file(file) #:nodoc:
+      self.somethings_from_file("todos", file)
+    end
+
+    # An Apple iCal version 3 repository.
+    module Ical3
+      class Calendar
+        def initialize(dir) # :nodoc:
+          @dir = dir
+        end
+        def plist(key) #:nodoc:
+           Plist::parse_xml( @dir + "/Info.plist")[key]
+        end
+
+        # The calendar name.
+        def name
+          plist "Title"
+        end
+
+        # Whether a calendar should be displayed.
+        def displayed
+          1 == plist("Checked")
+        end
+
+        # Array of all events defined in the calendar.
+        def events #:yield: Vevent
+          Dir[ @dir + "/Events/*.ics" ].map do |ics|
+            Repo.events_from_file(ics)
+          end.flatten
+        end
+
+        # Array of all todos defined in the calendar.
+        def todos #:yield: Vevent
+          Dir[ @dir + "/Events/*.ics" ].map do |ics|
+            Repo.todos_from_file(ics)
+          end.flatten
+        end
+
+      end
+
+      def self.each(where = "~/Library/Calendars") # :yield: Apple::Calendar
+        Dir[ File.expand_path(where + "/**/*.calendar") ].each do |dir|
+          yield Calendar.new(dir)
+        end
+        self
+      end
+    end
+    module Directory
+      class Calendar
+        def initialize(file) #:nodoc:
+          @file = file
+        end
+
+        def name
+          File.basename(@file)
+        end
+
+        def displayed
+          true
+        end
+
+        def events
+          Repo.events_from_file(@file)
+        end
+
+        def todos
+          Repo.todos_from_file(@file)
+        end
+      end
+
+      def self.each(where)
+         Dir[ File.expand_path(where + "/**/*.ics") ].each do |file|
+           yield Calendar.new(file)
+         end
+         self
+      end
+    end
+  end
+end
+

data/lib/vpim/time.rb

@@ -21,7 +21,7 @@ class Time
 
     # Returns a new Time, +months+ later than this time. The day will be
     # rounded down if it is not valid for that month.
-    # 31 plus 1 month will be on Feb 28!
+    # Jan 31 plus 1 month will be on Feb 28!
     def plus_month(months)
       d = Date.new(year, month, day)
       d >>= months

data/lib/vpim/version.rb

@@ -7,9 +7,9 @@
 =end
 
 module Vpim
-  PRODID = '-//Ensemble Independent//vPim 0.597//EN'
+  PRODID = '-//Ensemble Independent//vPim 0.602//EN'
 
-  VERSION = '0.597'
+  VERSION = '0.602'
 
   # Return the API version as a string.
   def Vpim.version

data/samples/README.mutt

@@ -0,0 +1,93 @@
+
+** cmd-itip.rb
+
+This script pretty-prints iTIP calendar invitations, often sent by email using iMIP
+as text/calendar objects.
+
+Download the latest vPim from:
+
+  http://rubyforge.org/projects/vpim/
+
+It requires Ruby to be installed.
+
+Install vpim:
+
+  tar -xzf vpim-XX.tgz
+  cd vpim-XX
+  ruby install.rb config
+  ruby install.rb setup
+  sudo ruby install.rb install
+
+Install cmd-itip.rb into your path, perhaps without the extension.
+
+  cp samples/cmd-itip.rb ~/bin/cmd-itip
+  chmod +x ~/bin/cmd-itip
+
+Modify your ~/.mailcap or /etc/mailcap files to call cmd-itip, add a line like:
+
+  text/calendar; cmd-itip --myaddr "sroberts@" %s; copiousoutput
+
+If you give a REGEX to --myaddr to tell cmd-itip your email addresses, cmd-itip
+will avoid printing some information on the attendees to an invitation.
+
+Modify muttrc to autoview calendars with a command like:
+
+  auto_view text/calendar
+
+Notes on Notes;
+
+Because Domino sends a close-to-unreadable text/plain attachment along with the
+text/calendar in a multipart/alternative, and the text/plain is first in the
+alternatives, the garbage will be at the top, and the nicely printed calendar
+at the bottom. Because of this, I reorder the view preference so the calendar
+invitation is clearly printed at the top of the message with a muttrc command
+like:
+
+ alternative_order text/calendar text/plain
+
+Domino also includes the calendar twice in the mail message, so you'll see it
+twice, I don't know what to do about that.
+
+Notes on application/octet-stream:
+
+Some calendar programs, such as Apple's Mail.app, wrongly send iCalendar attachments
+with a content-type of application/octet-stream. In order to be processed correctly, use
+the mutt 1.5 or later capability to lookup the correct MIME content-type based on the
+file extension. Put this in your muttrc file:
+
+ mime_lookup application/octet-stream
+
+and ensure /etc/mime.types or ~/.mime.types contains:
+
+  text/calendar       ics
+
+
+
+** vcf-to-mutt.rb
+
+This script searches a set of vCards can output the results as a Mutt query response,
+or a Mutt aliases file.
+
+It used to support querying the OS X Address Book, but that is better done with lbdb, see
+http://www.spinnaker.de/lbdb/.
+
+To install, you must:
+
+1 - install vPim (see README)
+
+3 - copy vcf-to-mutt into a directory in your path, such
+    as ~/bin, and chmod +x vcf-to-mutt.rb to make it executable.
+
+4 - Put in your muttrc file (either ~/.muttrc or ~/.mutt/muttrc) a line such as:
+
+set query_command = "vcf-to-mutt.rb '%s'"
+
+5 - The query command ("Q") will query the address book, control-t will give you auto-completion
+    of email addresses, see the Mutt manual page.
+
+
+** mutt-aliases-to-vcf.rb
+
+This script converts a mutt aliases file into a vCard file.
+
+

data/samples/ab-query.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+$-w = true
+$:.unshift File.dirname($0) + '/../lib'
+
+require 'osx-wrappers'
+
+require 'getoptlong'
+require 'vpim/vcard'
+require 'osx-wrappers'
+
+HELP =<<EOF
+Usage: ab-query.rb [--me] [--all]
+
+Queries the OS X Address Book for vCards.
+
+ -h, --help print this helpful message
+ -m, --me   list my vCard
+ -a, --all  list all vCards
+EOF
+
+opts = GetoptLong.new(
+  [ "--help",    "-h",              GetoptLong::NO_ARGUMENT ],
+  [ "--me",      "-m",              GetoptLong::NO_ARGUMENT ],
+  [ "--all",     "-a",              GetoptLong::NO_ARGUMENT ]
+)
+
+abook = nil
+
+opts.each do |opt, arg|
+  case opt
+    when "--help" then
+      puts HELP
+      exit 0
+
+    when "--all" then
+      abook = OSX::ABAddressBook.sharedAddressBook unless abook
+
+      abook.people.to_a.each {
+        |person|
+
+        puts person.vCard
+      }
+
+    when "--me" then
+     abook = OSX::ABAddressBook.sharedAddressBook unless abook
+
+     puts abook.me.vCard
+  end
+end
+
+
+unless abook
+  puts HELP
+  exit 1
+end
+