Fix rubocop complaints.

[chef.git] / cookbooks / planet / files / default / replication-bin / replicate-changesets

diff --git a/cookbooks/planet/files/default/replication-bin/replicate-changesets b/cookbooks/planet/files/default/replication-bin/replicate-changesets
index 87acbcccb0862b74a33b765df28672fd8c824e4f..8fd78a1bc33e1dfee2a81a535d26b24d30290d7e 100644 (file)
--- a/cookbooks/planet/files/default/replication-bin/replicate-changesets
+++ b/cookbooks/planet/files/default/replication-bin/replicate-changesets
@@ -1,12 +1,13 @@
 #!/usr/bin/ruby
 
 #!/usr/bin/ruby
 

-require 'rubygems'
-require 'pg'
-require 'yaml'
-require 'time'
-require 'fileutils'
-require 'xml/libxml'
-require 'zlib'
+require "rubygems"
+require "pg"
+require "yaml"
+require "time"
+require "fileutils"
+require "xml/libxml"
+require "zlib"
+require "set"

 
 # after this many changes, a changeset will be closed
 CHANGES_LIMIT = 50000
 
 # after this many changes, a changeset will be closed
 CHANGES_LIMIT = 50000


@@ -14,6 +15,12 @@ CHANGES_LIMIT = 50000
 # this is the scale factor for lat/lon values stored as integers in the database
 GEO_SCALE = 10000000
 
 # this is the scale factor for lat/lon values stored as integers in the database
 GEO_SCALE = 10000000
 

+##
+# replace characters which cannot be represented in XML 1.0.
+def xml_sanitize(str)
+  str.gsub(/[\x00-\x08\x0b\x0c\x0e-\x20]/, "?")
+end
+

 ##
 # changeset class keeps some information about changesets downloaded from the
 # database - enough to let us know which changesets are closed/open & recently
 ##
 # changeset class keeps some information about changesets downloaded from the
 # database - enough to let us know which changesets are closed/open & recently


@@ -22,10 +29,10 @@ class Changeset
   attr_reader :id, :created_at, :closed_at, :num_changes
 
   def initialize(row)
   attr_reader :id, :created_at, :closed_at, :num_changes
 
   def initialize(row)

-    @id = row['id'].to_i
-    @created_at = Time.parse(row['created_at'])
-    @closed_at = Time.parse(row['closed_at'])
-    @num_changes = row['num_changes'].to_i
+    @id = row["id"].to_i
+    @created_at = Time.parse(row["created_at"])
+    @closed_at = Time.parse(row["closed_at"])
+    @num_changes = row["num_changes"].to_i

   end
 
   def closed?(t)
   end
 
   def closed?(t)


@@ -41,29 +48,116 @@ class Changeset
   end
 end
 
   end
 end
 

+##
+# builds an XML representation of a changeset from the database
+class ChangesetBuilder
+  def initialize(now, conn)
+    @now = now
+    @conn = conn
+  end
+
+  def changeset_xml(cs)
+    xml = XML::Node.new("changeset")
+    xml["id"] = cs.id.to_s
+    xml["created_at"] = cs.created_at.getutc.xmlschema
+    xml["closed_at"] = cs.closed_at.getutc.xmlschema if cs.closed?(@now)
+    xml["open"] = cs.open?(@now).to_s
+    xml["num_changes"] = cs.num_changes.to_s
+
+    res = @conn.exec("select u.id, u.display_name, c.min_lat, c.max_lat, c.min_lon, c.max_lon from users u join changesets c on u.id=c.user_id where c.id=#{cs.id}")
+    xml["user"] = xml_sanitize(res[0]["display_name"])
+    xml["uid"] = res[0]["id"]
+
+    unless res[0]["min_lat"].nil? ||
+           res[0]["max_lat"].nil? ||
+           res[0]["min_lon"].nil? ||
+           res[0]["max_lon"].nil?
+      xml["min_lat"] = (res[0]["min_lat"].to_f / GEO_SCALE).to_s
+      xml["max_lat"] = (res[0]["max_lat"].to_f / GEO_SCALE).to_s
+      xml["min_lon"] = (res[0]["min_lon"].to_f / GEO_SCALE).to_s
+      xml["max_lon"] = (res[0]["max_lon"].to_f / GEO_SCALE).to_s
+    end
+
+    add_tags(xml, cs)
+    add_comments(xml, cs)
+
+    xml
+  end
+
+  def add_tags(xml, cs)
+    res = @conn.exec("select k, v from changeset_tags where changeset_id=#{cs.id}")
+    res.each do |row|
+      tag = XML::Node.new("tag")
+      tag["k"] = xml_sanitize(row["k"])
+      tag["v"] = xml_sanitize(row["v"])
+      xml << tag
+    end
+  end
+
+  def add_comments(xml, cs)
+    # grab the visible changeset comments as well
+    res = @conn.exec("select cc.author_id, u.display_name as author, cc.body, cc.created_at from changeset_comments cc join users u on cc.author_id=u.id where cc.changeset_id=#{cs.id} and cc.visible order by cc.created_at asc")
+    xml["comments_count"] = res.num_tuples.to_s
+
+    # early return if there aren't any comments
+    return unless res.num_tuples > 0
+
+    discussion = XML::Node.new("discussion")
+    res.each do |row|
+      comment = XML::Node.new("comment")
+      comment["uid"] = row["author_id"]
+      comment["user"] = xml_sanitize(row["author"])
+      comment["date"] = Time.parse(row["created_at"]).getutc.xmlschema
+      text = XML::Node.new("text")
+      text.content = xml_sanitize(row["body"])
+      comment << text
+      discussion << comment
+    end
+    xml << discussion
+  end
+end
+

 ##
 # state and connections associated with getting changeset data
 # replicated to a file.
 class Replicator
   def initialize(config)
     @config = YAML.load(File.read(config))
 ##
 # state and connections associated with getting changeset data
 # replicated to a file.
 class Replicator
   def initialize(config)
     @config = YAML.load(File.read(config))

-    @state = YAML.load(File.read(@config['state_file']))
-    @conn = PGconn.connect(@config['db'])
+    @state = YAML.load(File.read(@config["state_file"]))
+    @conn = PGconn.connect(@config["db"])

     @now = Time.now.getutc
   end
 
   def open_changesets
     @now = Time.now.getutc
   end
 
   def open_changesets

-    last_run = @state['last_run']
+    last_run = @state["last_run"]

     last_run = (@now - 60) if last_run.nil?
     last_run = (@now - 60) if last_run.nil?

-    @state['last_run'] = @now
+    @state["last_run"] = @now

     # pretty much all operations on a changeset will modify its closed_at
     # time (see rails_port's changeset model). so it is probably enough
     # for us to look at anything that was closed recently, and filter from
     # there.
     # pretty much all operations on a changeset will modify its closed_at
     # time (see rails_port's changeset model). so it is probably enough
     # for us to look at anything that was closed recently, and filter from
     # there.

-    @conn
-      .exec("select id, created_at, closed_at, num_changes from changesets where closed_at > ((now() at time zone 'utc') - '1 hour'::interval)")
-      .map { |row| Changeset.new(row) }
-      .select { |cs| cs.activity_between?(last_run, @now) }
+    changesets = @conn
+                 .exec("select id, created_at, closed_at, num_changes from changesets where closed_at > ((now() at time zone 'utc') - '1 hour'::interval)")
+                 .map { |row| Changeset.new(row) }
+                 .select { |cs| cs.activity_between?(last_run, @now) }
+
+    # set for faster presence lookups by ID
+    cs_ids = Set.new(changesets.map(&:id))
+
+    # but also add any changesets which have new comments
+    new_ids = @conn
+              .exec("select distinct changeset_id from changeset_comments where created_at >= '#{last_run}' and created_at < '#{@now}' and visible")
+              .map { |row| row["changeset_id"].to_i }
+              .select { |c_id| !cs_ids.include?(c_id) }
+
+    new_ids.each do |id|
+      @conn
+        .exec("select id, created_at, closed_at, num_changes from changesets where id=#{id}")
+        .map { |row| Changeset.new(row) }
+        .each { |cs| changesets << cs }
+    end
+
+    changesets.sort_by(&:id)

   end
 
   # creates an XML file containing the changeset information from the
   end
 
   # creates an XML file containing the changeset information from the


@@ -71,44 +165,16 @@ class Replicator
   def changeset_dump(changesets)
     doc = XML::Document.new
     doc.root = XML::Node.new("osm")
   def changeset_dump(changesets)
     doc = XML::Document.new
     doc.root = XML::Node.new("osm")

-    { 'version' => '0.6',
-      'generator' => 'replicate_changesets.rb',
-      'copyright' => "OpenStreetMap and contributors",
-      'attribution' => "http://www.openstreetmap.org/copyright",
-      'license' => "http://opendatacommons.org/licenses/odbl/1-0/" }
+    { "version" => "0.6",
+      "generator" => "replicate_changesets.rb",
+      "copyright" => "OpenStreetMap and contributors",
+      "attribution" => "http://www.openstreetmap.org/copyright",
+      "license" => "http://opendatacommons.org/licenses/odbl/1-0/" }

       .each { |k, v| doc.root[k] = v }
 
       .each { |k, v| doc.root[k] = v }
 

+    builder = ChangesetBuilder.new(@now, @conn)

     changesets.each do |cs|
     changesets.each do |cs|

-      xml = XML::Node.new("changeset")
-      xml['id'] = cs.id.to_s
-      xml['created_at'] = cs.created_at.getutc.xmlschema
-      xml['closed_at'] = cs.closed_at.getutc.xmlschema if cs.closed?(@now)
-      xml['open'] = cs.open?(@now).to_s
-      xml['num_changes'] = cs.num_changes.to_s
-
-      res = @conn.exec("select u.id, u.display_name, c.min_lat, c.max_lat, c.min_lon, c.max_lon from users u join changesets c on u.id=c.user_id where c.id=#{cs.id}")
-      xml['user'] = res[0]['display_name']
-      xml['uid'] = res[0]['id']
-
-      unless res[0]['min_lat'].nil? ||
-             res[0]['max_lat'].nil? ||
-             res[0]['min_lon'].nil? ||
-             res[0]['max_lon'].nil?
-        xml['min_lat'] = (res[0]['min_lat'].to_f / GEO_SCALE).to_s
-        xml['max_lat'] = (res[0]['max_lat'].to_f / GEO_SCALE).to_s
-        xml['min_lon'] = (res[0]['min_lon'].to_f / GEO_SCALE).to_s
-        xml['max_lon'] = (res[0]['max_lon'].to_f / GEO_SCALE).to_s
-      end
-
-      res = @conn.exec("select k, v from changeset_tags where changeset_id=#{cs.id}")
-      res.each do |row|
-        tag = XML::Node.new("tag")
-        tag['k'] = row['k']
-        tag['v'] = row['v']
-        xml << tag
-      end
-
-      doc.root << xml
+      doc.root << builder.changeset_xml(cs)

     end
 
     doc.to_s
     end
 
     doc.to_s


@@ -116,12 +182,12 @@ class Replicator
 
   # saves new state (including the changeset dump xml)
   def save!
 
   # saves new state (including the changeset dump xml)
   def save!

-    File.open(@config['state_file'], "r") do |fl|
+    File.open(@config["state_file"], "r") do |fl|

       fl.flock(File::LOCK_EX)
 
       fl.flock(File::LOCK_EX)
 

-      sequence = (@state.key?('sequence') ? @state['sequence'] + 1 : 0)
-      data_file = @config['data_dir'] + format("/%03d/%03d/%03d.osm.gz", sequence / 1000000, (sequence / 1000) % 1000, (sequence % 1000))
-      tmp_state = @config['state_file'] + ".tmp"
+      sequence = (@state.key?("sequence") ? @state["sequence"] + 1 : 0)
+      data_file = @config["data_dir"] + format("/%03d/%03d/%03d.osm.gz", sequence / 1000000, (sequence / 1000) % 1000, (sequence % 1000))
+      tmp_state = @config["state_file"] + ".tmp"

       tmp_data = "/tmp/changeset_data.osm.tmp"
       # try and write the files to tmp locations and then
       # move them into place later, to avoid in-progress
       tmp_data = "/tmp/changeset_data.osm.tmp"
       # try and write the files to tmp locations and then
       # move them into place later, to avoid in-progress


@@ -131,12 +197,20 @@ class Replicator
         Zlib::GzipWriter.open(tmp_data) do |fh|
           fh.write(changeset_dump(open_changesets))
         end
         Zlib::GzipWriter.open(tmp_data) do |fh|
           fh.write(changeset_dump(open_changesets))
         end

-        @state['sequence'] = sequence
+        @state["sequence"] = sequence

         File.open(tmp_state, "w") do |fh|
           fh.write(YAML.dump(@state))
         end
         File.open(tmp_state, "w") do |fh|
           fh.write(YAML.dump(@state))
         end

+
+        # sanity check: the files we're moving into place
+        # should be non-empty.
+        fail "Temporary gzip file should exist, but doesn't." unless File.exist?(tmp_data)
+        fail "Temporary state file should exist, but doesn't." unless File.exist?(tmp_state)
+        fail "Temporary gzip file should be non-empty, but isn't." if File.zero?(tmp_data)
+        fail "Temporary state file should be non-empty, but isn't." if File.zero?(tmp_state)
+

         FileUtils.mv(tmp_data, data_file)
         FileUtils.mv(tmp_data, data_file)

-        FileUtils.mv(tmp_state, @config['state_file'])
+        FileUtils.mv(tmp_state, @config["state_file"])

         fl.flock(File::LOCK_UN)
 
       rescue
         fl.flock(File::LOCK_UN)
 
       rescue


@@ -148,5 +222,10 @@ class Replicator
   end
 end
 
   end
 end
 

-rep = Replicator.new(ARGV[0])
-rep.save!
+begin
+  rep = Replicator.new(ARGV[0])
+  rep.save!
+rescue StandardError => e
+  STDERR.puts "ERROR: #{e.message}"
+  exit 1
+end