fairtilizer-vpim 0.695

data/lib/vpim/agent/atomize.rb

@@ -0,0 +1,104 @@
+=begin
+  Copyright (C) 2009 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 "atom"
+
+module Vpim
+  module Agent
+
+    module Atomize
+      MIME = "application/atom+xml"
+
+      # +ical+, an icalendar, or at least a Repo calendar's subset of an Icalendar
+      # +feeduri+, the atom xml should know the URI of where the feed is available from.
+      # +caluri+, optionally, the URI of the calendar its converted from.
+      #
+      # TODO - and the URI of an alternative/html representation of this feed?
+      def self.calendar(ical, feeduri, caluri = nil, calname = nil)
+        mime = MIME
+
+        feeduri = feeduri.to_str
+        caluri = caluri
+        calname = (calname or caluri or "Unknown").to_str
+
+        f = Atom::Feed.new
+        # Mandatory attributes:
+        # For ID, we should use http://.../ics/atom?....., or just the URL of the ics?
+        #   I think it can be a full URI... or maybe a sha-1 of our full URI?
+        # or like gmail, no id for feed,
+        #   <id>tag:gmail.google.com,2004:1295062805013769502</id>
+        #
+        f.id = feeduri
+        f.title = calname
+        f.updated = Time.now
+        f.authors << Atom::Person.new(:name => (caluri or calname))
+        f.generator = Atom::Generator.new do |g|
+          g.name = Vpim::PRODID
+          g.uri = "http://vpim.rubyforge.org"
+          g.version = Vpim::VERSION
+        end
+
+        f.links << Atom::Link.new do |l|
+          l.href = feeduri
+          l.type = mime
+          l.rel  = :self
+        end
+
+        if caluri
+          # This is maybe better described as :via, but with :alternate being
+          # an html view of this feed.
+          #
+          # TODO should I change the scheme to be webcal?
+          # TODO should I extend URI to support webcal?
+          f.links << Atom::Link.new do |l|
+            l.href = caluri
+            l.type = "text/calendar"
+            l.rel  = :alternate
+          end
+        end
+
+        # .icon = uri to the vAgent icon
+        entry_id = 0
+        ical.events do |ve|
+          # TODO - infinite?
+          ve.occurrences do |t|
+            f.entries << Atom::Entry.new do |e|
+              # iCalendar -> atom
+              # -----------------
+              # summary -> title
+              # description -> text/content
+              # uid -> id
+              # created -> published?
+              # organizer -> author?
+              # contact -> author?
+              # last-mod -> semantically, this is updated, but atom doesn't
+              #   have the notion that an entry has a relationship to a time,
+              #   other than the time the entry itself was published, and when
+              #   the entry gets updated. We'll abuse updated for the event's time.
+              # categories -> where do "tags" go in atom, if anywhere?
+              # attachment -> into a link?
+              e.title = ve.summary if ve.summary
+              e.content = Atom::Content::Text.new(ve.description) if ve.description
+              e.updated = t
+
+              # Use "tag:", as defined by RFC4151, and use event UID if possible. Otherwise,
+              # construct something. Maybe I should mix something in to make it unique for
+              # each time a feed is generated for the calendar?
+              entry_id += 1
+              tag = ve.uid || "#{entry_id}@#{feeduri}"
+              e.id = "tag:vpim.rubyforge.org,2009:#{tag}"
+            end
+          end
+        end
+        return f
+      end
+    end # Atomize
+
+  end # Agent
+end # Vpim
+

data/lib/vpim/agent/base.rb

@@ -0,0 +1,73 @@
+=begin
+  Copyright (C) 2009 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 'cgi'
+
+require 'sinatra/base'
+
+# TODO Pasting of webcal links, conversion to webcal links?
+
+module Vpim
+  module Agent
+
+    class Base < Sinatra::Base
+      # Ensure that this happens...
+      set :haml, :format=>:html4 # Appears to do nothing, but maybe it will some day...
+
+      def css(template)
+        render :css, template, {}
+      end
+
+      def render_css(template, data, options) # :nodoc:
+        data
+      end
+
+      # Complete path, as requested by the client. Take care about CGI path rewriting.
+      def request_path
+        # Using .to_s because rack/request.rb does, though I think the Rack
+        # spec requires these to be strings already.
+        begin
+          URI.parse(env["SCRIPT_URI"].to_s).path
+        rescue
+          env["SCRIPT_NAME"].to_s + env["PATH_INFO"].to_s
+        end
+      end
+
+      # Complete path, as requested by the client, without the env's PATH_INFO.
+      # This is the path to whatever is "handling" the request.
+      #
+      # Recent discussions on how PATH_INFO must be decoded leads me to think
+      # this might not work if the path had any URL encoded characters in it.
+      def script_path
+        request_path.sub(/#{env["PATH_INFO"]}$/, "")
+      end
+
+      # URL-ready form of the host and port, where the port isn't specified if
+      # it is the default for the URL scheme.
+      def host_port
+        r = request
+        host_port = r.host
+
+        if r.scheme == "https" && r.port != 443 ||
+          r.scheme == "http" && r.port != 80
+          host_port << ":#{r.port}"
+        end
+
+        host_port
+      end
+
+      # URL to the script
+      def script_url
+        request.scheme + "://" + host_port + script_path
+      end
+
+    end # Base
+
+  end # Agent
+end # Vpim
+

data/lib/vpim/agent/calendars.rb

@@ -0,0 +1,173 @@
+=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 "cgi"
+require "uri"
+
+require "vpim/repo"
+require "vpim/agent/atomize"
+
+module Vpim
+  module Agent
+    # On failure, raise this with an error message. text/plain for now,
+    # text/html later. Will convert to a 404 and a message.
+    class NotFound < Exception
+      def initialize(name, path)
+        super %{Resource "#{name}" under "#{path.prefix}" was not found!}
+      end
+    end
+
+    class Path
+      def self.split_path(path)
+        begin
+          path = path.to_ary
+        rescue NameError
+          path = path.split("/")
+        end
+        path.map{|w| CGI.unescape(w)}
+      end
+
+      # URI is the uri being queried, base is where this path is mounted under?
+      def initialize(uri, base = "")
+        @uri  = URI.parse(uri.to_s)
+        #pp [uri, base, @uri]
+       if @uri.path.size == 0
+         @uri.path = "/"
+       end
+        @path = Path.split_path(@uri.path)
+        @base = base.to_str
+        @mark = 0
+
+        @base.split.size.times{ shift }
+      end
+
+      def uri
+        @uri.to_s
+      end
+
+      def to_path
+        self
+      end
+
+      # TODO - call this #next
+      def shift
+        if @path[@mark]
+          @path[@mark += 1]
+        end
+      end
+
+      def append(name, scheme = nil)
+        uri = @uri.dup
+        uri.path += "/" + CGI.escape(name)
+        if scheme
+          uri.scheme = scheme
+        end
+        uri
+      end
+
+      def prefix(len = nil)
+        len ||= @mark
+        @path[0, len].map{|p| CGI.escape(p)}.join("/") + "/"
+      end
+
+    end
+
+    module Form
+      ATOM  = Atomize::MIME
+      HTML  = "text/html"
+      ICS   = "text/calendar"
+      PLAIN = "text/plain"
+      VCF   = "text/directory"
+    end
+
+    # Return an HTML description of a list of resources accessible under this
+    # path.
+    class ResourceList
+      def initialize(description, items)
+        @description = description
+        @items = items
+      end
+
+      def get(path)
+        return <<__, Form::HTML
+<html><body>
+#{@description}
+<ul>
+  #{
+    @items.map do |name,description,scheme|
+      "<li><a href=\"#{path.append(name,scheme)}\">#{description || name}</a></li>\n"
+    end
+  }
+</ul>
+</body></html>
+__
+      end
+    end
+
+    # Return calendar information based on RESTful (lovein' the jargon...)
+    # paths. Input is a Vpim::Repo.
+    #
+    #   .../coding/month/atom
+    #   .../coding/events/month/ics              <- next month?
+    #   .../coding/events/month/2008-04/ics      <- a specified month?
+    #   .../coding/week/atom
+    #   .../year/atom
+    class Calendars
+      def initialize(repo)
+        @repo = repo
+      end
+
+      class Calendar
+        def initialize(cal)
+          @cal = cal
+          @list = ResourceList.new(
+              "Calendar #{@cal.name.inspect}:",
+              [
+                ["calendar", "download"],
+                ["calendar", "subscription", "webcal"],
+                ["atom",     "syndication"],
+              ]
+            )
+        end
+
+        def get(path)
+          form = path.shift
+
+          # TODO should redirect to an object, so that extra paths can be
+          # handled more gracefully.
+          case form
+          when nil
+            return @list.get(path)
+          when "calendar"
+            return @cal.encode, Form::ICS
+          when "atom"
+            return Atomize.calendar(@cal, path.uri, nil, @cal.name).to_xml, Form::ATOM
+          else
+            raise NotFound.new(form, path)
+          end
+        end
+      end
+
+      # Get object at this path. Return value is a tuple of data and mime content type.
+      def get(path)
+        case name = path.to_path.shift
+        when nil
+          list = ResourceList.new("Calendars:", @repo.map{|c| c.name})
+          return list.get(path)
+        else
+          if cal = @repo.find{|c| c.name == name}
+            return Calendar.new(cal).get(path)
+          else
+            raise NotFound.new(name, path)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/vpim/agent/handler.rb

@@ -0,0 +1,26 @@
+=begin
+  Copyright (C) 2009 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 'sinatra/base'
+
+# Auto-choose our handler based on the environment.
+# TODO Code should be in Sinatra, and should handle Thin, Mongrel, etc.
+Sinatra::Base.configure do
+  server = Sinatra::Base.server
+  Sinatra::Base.set :server, Proc.new {
+      if ENV.include?("PHP_FCGI_CHILDREN")
+        break "fastcgi" # Must NOT be the correct class name!
+      elsif ENV.include?("REQUEST_METHOD")
+        break "cgi" # Must NOT be the correct class name!
+      else
+        # Fall back on whatever it was going to be.
+        server
+      end
+  }
+end
+

data/lib/vpim/agent/ics.rb

@@ -0,0 +1,161 @@
+=begin
+  Copyright (C) 2009 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 'cgi'
+
+require 'vpim/agent/base'
+require 'vpim/agent/atomize'
+require 'vpim/repo'
+require 'vpim/view'
+
+require 'sinatra/base'
+
+module Vpim
+  module Agent
+
+    class Ics < Base
+      use_in_file_templates!
+
+      def atomize(caluri, feeduri)
+        repo = Vpim::Repo::Uri.new(caluri)
+        cal = repo.find{true}
+        cal = View.week(cal)
+        feed = Agent::Atomize.calendar(cal, feeduri, caluri, cal.name)
+        return feed.to_xml,  Agent::Atomize::MIME
+      end
+
+      ## Route handlers:
+      def get_base(from)
+        @url_base = script_url   # agent mount point
+        @url_ics  = from         # ics from here
+        @url_atom = nil          # atom feed from here, if ics is accessible
+        @url_error= nil          # error message, if is is not accessible
+
+        if not from.empty?
+          begin
+            atomize(from, "http://example.com")
+            @url_atom = @url_base + "/atom" + "?" + from
+          rescue
+            @url_error = CGI.escapeHTML($!.to_s)
+          end
+        end
+
+        haml :"vpim/agent/ics/view"
+      end
+
+      # When we support other forms..
+      #get '/ics/:form' do
+      #  form = params[:form]
+      def get_atom(caluri)
+        if caluri.empty?
+          redirect script_url
+        end
+
+        feeduri = script_url + "/atom?" + caluri
+
+        begin
+          xml, xmltype = atomize(caluri, feeduri)
+          content_type xmltype
+          body xml
+        rescue
+          redirect script_url + "?" + caluri
+        end
+      end
+
+      def get_style
+        content_type 'text/css'
+        css :"vpim/agent/ics/style"
+      end
+
+      ## Sinatra routing:
+      get '/?' do
+        get_base(env['QUERY_STRING'])
+      end
+
+      post "/?" do
+        redirect script_url + "?" + (params[:url] || "")
+      end
+
+      get "/atom" do
+        get_atom(env['QUERY_STRING'])
+      end
+
+      get '/style.css' do
+        get_style
+      end
+
+    end # Ics
+
+  end # Agent
+end # Vpim
+
+__END__
+@@vpim/agent/ics/style
+body {
+  background-color: gray;
+}
+h1 {
+  border-bottom: 3px solid #8B0000;
+  font-size: large;
+}
+form {
+  margin-left: 10%;
+}
+input.text {
+  width: 80%;
+}
+a {
+  color: black;
+}
+a:hover {
+  color: #8B0000;
+}
+tt {
+  margin-left: 10%;
+}
+.footer {
+  border-top: 3px solid #8B0000;
+}
+@@vpim/agent/ics/view
+!!! strict
+%html
+  %head
+    %title Subscribe to calendar feeds as atom feeds
+    %link{:href => script_url + "/style.css", :media => "screen", :type => "text/css"}
+    %meta{:"http-equiv" => "Content-Type", :content => "text/html;charset=utf-8"}
+  %body
+    %h1 Subscribe to calendar feeds as atom feeds
+    %p
+      Calendar feeds are great, but when you want a reminder of what's coming up
+      in the next week, you might want those events as an atom feed.
+    %p
+      Paste the URL of the calendar below, submit it, and subscribe.
+    %form{:method => 'POST', :action => script_url}
+      %p
+        %input.text{:type => 'text', :name => 'url', :value => @url_ics}
+        %input{:type => 'submit', :value => 'Submit'}
+    - if @url_atom
+      %p
+        Subscribe to
+        %a{:href => @url_ics}= @url_ics
+        as:
+      %ul.feed
+        %li
+          %a{:href => @url_atom}= @url_atom
+          (atom feed)
+    - if @url_error
+      %p
+        Sorry, trying to access
+        %tt=@url_ics
+        resulted in:
+      %p
+        %tt= @url_error
+    .footer
+      :textile
+        Brought from the "Octet Cloud":http://octetcloud.com/ using "vPim":http://vpim.rubyforge.org/, by cloud monkey "Sam Roberts":mailto:vieuxtech@gmail.com.
+