vortex_client 0.6.0 → 0.7.0

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/examples/README.rdoc

@@ -0,0 +1,30 @@
+= Vortex Client Examples
+
+= publish_article.rb
+
+Creates a standard article. Stores file as JSON on server, which is the
+
+= upload_file.rb
+
+Upload local (binary) file to server.
+
+= personer_presentation.rb
+
+Create a person presentation that displays info from ldap and publications database.
+
+= publish_event.rb
+
+Publish an event with iCal link.
+
+= sitemap.rb
+
+Creates a file with that can be used as a basis for a sitemap.
+
+= create_collection.rb
+
+Creates various types of directories, called collections in webdav, on server.
+
+= unpublish.rb
+
+Hides documents for visitors by setting the documents unpublish-date to current time and date.
+

data/examples/create_personpresentations.rb

@@ -0,0 +1,147 @@
+# -*- coding: utf-8 -*-
+#
+# Create person presentations in vortex.
+#
+# Input is a vortex folder with images like this:
+#
+#    /person/
+#       /adm/
+#         username.jpg
+#         user2.jpg
+#
+# For each image, the script creates a folder, a person presentation named index.html
+# and moves the image file. After completion, the folder should look like this:
+#
+#    /person/
+#       /adm/
+#         username/
+#           index.html
+#           username.jpg
+#         user2/
+#           index.html
+#           user2.jpg
+#
+# Author: Thomas Flemming   thomasfl (at) usit.uio.no
+
+require 'rubygems'
+require 'vortex_client'
+require 'open-uri'
+require 'time'
+require 'ldap_util'
+
+def create_person_listing_folder(new_url)
+  mkdir(new_url)
+  puts "Creating folder: " + new_url
+  props = '<v:collection-type xmlns:v="vrtx">person-listing</v:collection-type>' +
+    '<v:resourceType xmlns:v="vrtx">person-listing</v:resourceType>'
+  begin
+    @vortex.proppatch(new_url, props )
+  rescue
+    puts "Warning: problems patching folder: " + new_url
+  end
+end
+
+def mkdir(url)
+  begin
+    @vortex.mkdir(url)
+  rescue
+    puts "Warning: mkdir(" + url + ") exists."
+  end
+end
+
+def copy(src,dest)
+  begin
+    @vortex.copy(src,dest)
+  rescue
+    puts "Warning: cp(src," + dest + ") exists."
+  end
+end
+
+def move(src,dest)
+  begin
+    @vortex.move(src,dest)
+  rescue
+    puts "Warning: move(src," + dest + ") exists."
+  end
+end
+
+
+def delete(dest)
+  begin
+    @vortex.delete(dest)
+  rescue
+    puts "Warning: delete(" + dest + ") failed."
+  end
+end
+
+def set_realname_as_title(username, path)
+  realname = ldap_realname(username)
+  if(realname) then
+    @vortex.proppatch(path, '<v:userTitle xmlns:v="vrtx">' + realname + '</v:userTitle>')
+  else
+    puts "Warning: Unable to get info from ldap on: " + username
+  end
+end
+
+def create_person_presentation(url, dest_folder, language)
+  username = dest_folder.sub(/\/$/,'')[/([^\/]*)$/,1]
+  dest_image_url = dest_folder + url[/([^\/]*)$/,1]
+  mkdir(dest_folder)
+  set_realname_as_title(username, dest_folder)
+
+  copy(url,dest_image_url)
+
+  if(url.to_s.match(/\/vit\//))then
+    scientific = true
+  else
+    scientific = false
+  end
+  # scientific = true
+
+  person = Vortex::Person.new(:user => username,
+                            :image => dest_image_url,
+                            :language => language,
+                            :scientific => scientific,
+                            :url => dest_folder + 'index.html')
+
+  # Use the 'administrative' html template.
+  # Override default html template used for scientific presentations.
+  #    person.html = person.create_html(:language => language, :html_template => :administrative)
+
+  @vortex.publish(person)
+end
+
+
+def create_presentations_from_images(src_url, dest_url, language)
+  count = 0
+  @vortex.find(src_url,:recursive => true,:suppress_errors => true) do |item|
+    url = item.url.to_s
+    if(item.type == :directory) then
+      new_url = url.gsub(src_url,dest_url)
+      create_person_listing_folder(new_url)
+    elsif(url.match(/\.jpg$|\.png$/i)) then
+      dest_folder = url.gsub(src_url,dest_url)
+      dest_folder = dest_folder.sub(/\.jpg$|\.png$/i,'/')
+      create_person_presentation(url, dest_folder, language)
+    end
+    count += 1
+  end
+  return count
+end
+
+# src_url = 'https://nyweb3-dav.uio.no/konv/ubo/'
+src_url = 'https://nyweb1-dav.uio.no/personer/genererte-presentasjoner/econ/'
+@vortex = Vortex::Connection.new(src_url, :use_osx_keychain => true)
+
+# puts "Restore from backup..."
+# delete(src_url)
+# copy('https://nyweb3-dav.uio.no/konv/ubo_backup/', src_url)
+
+dest_url = 'https://nyweb1-dav.uio.no/personer/genererte-presentasjoner/econ_generert/' ## https://nyweb3-dav.uio.no/konv/ubo_no/'
+count = create_presentations_from_images(src_url, dest_url, :norwegian)
+puts "\n\nDone. Created " + count.to_s + " presentations."
+
+# dest_url = 'https://nyweb3-dav.uio.no/konv/ubo_en/'
+# count = create_presentations_from_images(src_url, dest_url, :english)
+# puts "\n\nDone. Created " + count.to_s + " presentations."
+

data/examples/import_static_site.rb

@@ -0,0 +1,211 @@
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'open-uri'
+require 'vortex_client'
+require 'uri'
+require 'nokogiri'
+require 'htmlentities'
+require 'json'
+require 'iconv'
+
+class MigrateSuicidologi
+  attr :vortex, :uri
+
+  def initialize(url)
+    @vortex = Vortex::Connection.new(url,:use_osx_keychain => true)
+    @uri = URI.parse(url)
+  end
+
+  # Common regexp for title and introduction
+  def clean_string(string)
+    string = string.gsub(/\r|\n/,'').sub(/^ */,'').sub(/\s*$/,'').gsub(/ +/,' ')
+    coder = HTMLEntities.new()
+    string = coder.decode(string) # Remove html entities
+    return string
+  end
+
+  # Return a list of all documents found, recursively.
+  def crawler(url)
+    result = []
+    doc = Nokogiri::HTML.parse(open(url))
+    row = doc.xpath("//tr[4]").first
+    while(row)do
+      row_doc = Nokogiri::HTML(row.to_s)
+      link = row_doc.xpath("//a").first
+      if(link)then
+        href = url + link.attribute("href").value
+        if(href =~ /\/$/)then
+          result = result + crawler(href)
+        else
+          result << href
+        end
+      end
+      row = row.next
+    end
+    return result
+  end
+
+  # Scrape an issue
+  def scrape_periodical(url)
+    html = open(url).read
+
+    doc = Nokogiri::HTML.parse(html)
+
+    # Detect encoding
+    doc.encoding = 'iso-8859-1'
+
+    if(doc.to_s =~ /æ|ø|å/)then
+      puts "Encoding detected: iso-8859-1"
+    else
+      doc2 = Nokogiri::HTML.parse(html)
+      doc2.encoding = 'utf-8'
+      if(doc2.to_s =~ /æ|ø|å/)then  # This method only works for norwegian
+        puts "Encoding detected: utf-8"
+        doc = Nokogiri::HTML.parse(html)
+        doc.encoding = 'utf-8'
+      else
+        puts "Encoding detected: unknown"
+      end
+    end
+
+    issue = { }
+    issue[:title] = clean_string( doc.css('.MenuHeading1').inner_text )
+    issue[:title] =~ /,(.*)/
+    folder_title = clean_string( $1 )
+    folder_title = folder_title[0..0].upcase + folder_title[1..9999]
+    issue[:folder_title] = folder_title
+    issue[:introduction] = clean_string( doc.css('.MenuHeading2').inner_text )
+    issue[:body] = clean_html(doc.xpath("//ul")).to_s
+
+    url =~ /([^\/]*)-(.*)\..*$/
+    issue[:year] = $1
+    issue[:folder_name] = $2
+    url =~ /([^\/|]*)\.html$/
+    path = 'http://www.med.uio.no/ipsy/ssff/suicidologi/' + $1 + "/"
+    issue[:files] = crawler(path)
+    return issue
+  end
+
+  # Remove unwanted tags from body
+  def clean_html(doc)
+
+    # Remove font tags
+    doc.xpath('//font').each do |node|
+      node.children.each do |child|
+        child.parent = node.parent
+      end
+      node.remove
+    end
+
+    # Remove path to links:
+    doc.xpath('//a').each do |node|
+      href = node.attr("href")
+      href =~ /([^\/]*)$/
+      node.set_attribute("href", $1)
+    end
+
+    # Remove <br> tags within li elements
+    doc.xpath('//li').each do |li|
+      li.xpath('//br').each do |br|
+        br.remove
+      end
+    end
+
+    # Remove <p> tags within li elements
+    doc.xpath('//li').each do |li|
+      li.xpath('//p').each do |p|
+        p.children.each do |child|
+          child.parent = p.parent
+        end
+        p.remove
+      end
+    end
+
+    return doc
+  end
+
+  def create_folders(issue)
+    puts "Creating folders?"
+    year_folder = @uri.path + issue[:year]
+    if(not(@vortex.exists?(year_folder)))then
+      puts "  Creating folder #{year_folder}/"
+      @vortex.mkdir(year_folder)
+      @vortex.proppatch(year_folder, '<v:resourceType xmlns:v="vrtx">article-listing</v:resourceType>')
+      @vortex.proppatch(year_folder, '<v:collection-type xmlns:v="vrtx">article-listing</v:collection-type>')
+    end
+
+    issue_folder = year_folder + "/" + issue[:folder_name]
+    if(not(@vortex.exists?(issue_folder)))then
+      puts "  Creating folder #{issue_folder}/"
+      @vortex.mkdir(issue_folder)
+      @vortex.proppatch(issue_folder, '<v:resourceType xmlns:v="vrtx">article-listing</v:resourceType>')
+      @vortex.proppatch(issue_folder, '<v:collection-type xmlns:v="vrtx">article-listing</v:collection-type>')
+      @vortex.proppatch(issue_folder, '<v:userTitle xmlns:v="vrtx">' + issue[:folder_title] + '</v:userTitle>')
+    end
+
+  end
+
+  def copy_files(issue)
+    puts "Copying pdf files."
+    issue[:files].each do |url|
+      url =~ /([^\/]*)$/
+      basename = $1
+      content = open(url).read
+      path = @uri.path + issue[:year] + "/" + issue[:folder_name] + "/" + basename
+      puts url + " => " + path
+      @vortex.put_string(path,content)
+    end
+  end
+
+  def publish_article(issue)
+    puts "Publising article"
+    pathname = @uri.path + issue[:year] + "/" + issue[:folder_name] + "/index.html"
+    article  = Vortex::StructuredArticle.new(:title => issue[:title],
+                           :introduction => issue[:introduction],
+                           :body => issue[:body],
+                           :url => pathname,
+                           :publishedDate => Time.now ) #,
+                           # :author => "Halvor Aarnes")
+    path = @vortex.publish(article)
+  end
+
+  def migrate_issue(url)
+    issue = scrape_periodical(url)
+    debug = false
+    if(debug)then
+      puts "Year  : '#{issue[:year]}'"
+      puts "folder: '#{issue[:folder_name]}' / '#{issue[:folder_title]}'"
+      puts "Tittel: '#{issue[:title]}'"
+      puts "Intro : '#{issue[:introduction]}'"
+      puts "Body  : '#{issue[:body][0..110]}.."
+    end
+    # require 'pp'
+    # pp issue[:files]
+    # puts
+
+    create_folders(issue)
+    publish_article(issue)
+    copy_files(issue)
+  end
+
+  def migrate_all_issues(url)
+    files =crawler(url)
+    files.each do |file|
+      migrate_issue(file)
+      puts file
+    end
+  end
+
+end
+
+# Scrape all webpages found in src_url and store in dest_url
+dest_url = 'https://nyweb1-dav.uio.no/konv/ssff/suicidologi/'
+src_url = 'http://www.med.uio.no/ipsy/ssff/suicidologi/innholdsfortegnelser/'
+migration = MigrateSuicidologi.new(dest_url)
+migration.migrate_all_issues(src_url)
+
+
+# url = 'http://www.med.uio.no/ipsy/ssff/suicidologi/innholdsfortegnelser/2009-nr1.html'
+# TODO
+# - Sette publisert dato til år og ....?
+# - Alle ingressene har tegnsettproblemer? Iconv?

data/examples/no_right_margin.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'vortex_client'
+
+vortex = Vortex::Connection.new("https://www-dav.uio.no/")
+
+no_right_margin = '<hideAdditionalContent ' +
+  'xmlns="http://www.uio.no/vrtx/__vrtx/ns/structured-resources">true</hideAdditionalContent>'
+
+vortex.find('/konv/om/profil/', :recursive=>true)do|item|
+  item.proppatch(no_right_margin)
+end

data/examples/propfind_proppatch.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'vortex_client'
+
+vortex = Vortex::Connection.new("https://www-dav.vortex-demo.uio.no/", :use_osx_keychain => true)
+props = vortex.propfind('/index.html')
+
+vortex.proppatch('/index.html','<v:title xmlns:v="vrtx">Forside vortex demo</v:title>')

data/examples/replace_spike.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'vortex_client'
+require 'json'
+require 'scrape_vortex_search'
+require 'pp'
+require 'uri'
+
+# Replace text in json document on server
+# Optional resourcetype can
+def replace(host, path, from, to, *resourcetype)
+  verbose = false
+  host = host.sub(/\/$/,'')
+  uri = URI.parse(path)
+  url = host + uri.path
+  url = url.sub(/\/$/,'/index.html')
+
+  vortex = Vortex::Connection.new(host,:use_osx_keychain => true)
+  vortex.find(url) do |item|
+
+    data = nil
+    begin
+      data = JSON.parse(item.content)
+    rescue
+      if(verbose)then
+        puts "Warning. Bad document. Not json: " + item.uri.to_s
+      end
+      return 0
+    end
+
+    if(resourcetype[0] and resourcetype[0].class == String and data["resourcetype"] != resourcetype[0] )then
+      if(verbose)then
+        puts "Warning: resourcetype not: " + resourcetype[0]
+      end
+      return 0
+    end
+
+    puts "Oppdaterer: " + item.uri.to_s
+    new_content = item.content.sub(from,to)
+    item.content = new_content
+    return 1
+  end
+end