From: Matt Amos <zerebubuth@gmail.com>
Date: Sun, 14 Nov 2010 12:40:44 +0000 (+0000)
Subject: Initial work on support for multiple editors
X-Git-Tag: live~6303^2~41
X-Git-Url: https://git.openstreetmap.org/rails.git/commitdiff_plain/cd66a5db99fda4920ed559ec71163d5d01ba1f4a

Initial work on support for multiple editors
---

diff --git a/app/controllers/site_controller.rb b/app/controllers/site_controller.rb
index 1478c5773..0a1a55301 100644
--- a/app/controllers/site_controller.rb
+++ b/app/controllers/site_controller.rb
@@ -30,4 +30,38 @@ class SiteController < ApplicationController
   def key
     expires_in 7.days, :public => true
   end
+
+  def edit
+    session[:token] = @user.tokens.create.token unless session[:token] and UserToken.find_by_token(session[:token])
+    
+    @preferred_editor = @user.preferred_editor || DEFAULT_EDITOR
+
+    # Decide on a lat lon to initialise potlatch with. Various ways of doing this
+    if params['lon'] and params['lat']
+      @lon = params['lon'].to_f
+      @lat = params['lat'].to_f
+      @zoom = params['zoom'].to_i
+      
+    elsif params['mlon'] and params['mlat'] 
+      @lon = params['mlon'].to_f
+      @lat = params['mlat'].to_f
+      @zoom = params['zoom'].to_i
+      
+    elsif params['gpx']
+      #use gpx id to locate (dealt with below)
+      
+    elsif cookies.key?("_osm_location")
+      @lon, @lat, @zoom, layers = cookies["_osm_location"].split("|")
+      
+    elsif @user and !@user.home_lon.nil? and !@user.home_lat.nil? 
+      @lon = @user.home_lon
+      @lat = @user.home_lat
+      
+    else
+      #catch all.  Do nothing.  lat=nil, lon=nil
+      #Currently this results in potlatch starting up at 0,0 (Atlantic ocean).
+    end
+
+    @zoom = '14' if @zoom.nil?
+  end
 end
diff --git a/app/controllers/user_controller.rb b/app/controllers/user_controller.rb
index 19e8aeb7c..d73d38a17 100644
--- a/app/controllers/user_controller.rb
+++ b/app/controllers/user_controller.rb
@@ -109,6 +109,8 @@ class UserController < ApplicationController
       @user.home_lat = params[:user][:home_lat]
       @user.home_lon = params[:user][:home_lon]
 
+      @user.preferred_editor = params[:user][:preferred_editor]
+
       if @user.save
         set_locale
 
diff --git a/app/models/user.rb b/app/models/user.rb
index 1a50f7053..ecf93b6f7 100644
--- a/app/models/user.rb
+++ b/app/models/user.rb
@@ -33,6 +33,7 @@ class User < ActiveRecord::Base
   validates_numericality_of :home_lat, :allow_nil => true
   validates_numericality_of :home_lon, :allow_nil => true
   validates_numericality_of :home_zoom, :only_integer => true, :allow_nil => true
+  validates_inclusion_of :preferred_editor, :in => Editors::ALL_EDITORS, :allow_nil => true
 
   before_save :encrypt_password
 
diff --git a/app/views/site/_josm.html.erb b/app/views/site/_josm.html.erb
new file mode 100644
index 000000000..16f33bde0
--- /dev/null
+++ b/app/views/site/_josm.html.erb
@@ -0,0 +1,6 @@
+<div id="map">
+  <% query = "lat=#{@lat || 0}&lon=#{@lon || 0}&zoom=#{@zoom}" %>
+  <iframe src="http://127.0.0.1:8111/load_and_zoom?<%= query %>" width="100%" height="100%">
+    <p><%= t 'site.edit.no_iframe_support' %></p>
+  </iframe>
+</div>
diff --git a/app/views/site/_potlatch.html.erb b/app/views/site/_potlatch.html.erb
new file mode 100644
index 000000000..c255cef91
--- /dev/null
+++ b/app/views/site/_potlatch.html.erb
@@ -0,0 +1,40 @@
+<div id="map">
+  <%= t 'site.edit.flash_player_required' %>
+</div>
+
+<%= javascript_include_tag 'swfobject.js' %>
+<script type="text/javascript" defer="defer">
+  var brokenContentSize = $("content").offsetWidth == 0;
+  var fo = new SWFObject("/potlatch/potlatch.swf?d="+Math.round(Math.random()*1000), "potlatch", "100%", "100%", "6", "#FFFFFF");
+  // 700,600 for fixed size, 100%,100% for resizable
+  var changesaved=true;
+  var winie=false; if (document.all && window.print) { winie=true; }
+  
+  window.onbeforeunload=function() {
+    if (!changesaved) {
+      return '<%= escape_javascript(t('site.edit.potlatch_unsaved_changes')) %>';
+    }
+  }
+
+  function markChanged(a) { changesaved=a; }
+
+  function doSWF(lat,lon,sc) {
+    if (sc < 11) sc = 11;
+    fo.addVariable('winie',winie);
+    fo.addVariable('scale',sc);
+    fo.addVariable('token','<%= session[:token] %>');
+    if (lat) { fo.addVariable('lat',lat); }
+    if (lon) { fo.addVariable('long',lon); }
+    <% if params['gpx']     %>fo.addVariable('gpx'     ,'<%= h(params['gpx']    ) %>');<% end %>
+    <% if params['way']     %>fo.addVariable('way'     ,'<%= h(params['way']    ) %>');<% end %>
+    <% if params['node']    %>fo.addVariable('node'    ,'<%= h(params['node']   ) %>');<% end %>
+    <% if params['tileurl'] %>fo.addVariable('custombg','<%= h(params['tileurl']) %>');<% end %>
+    fo.write("map");
+  }
+
+  doSWF(<%= @lat || 'null' %>,<%= @lon || 'null' %>,<%= @zoom %>);
+
+  function setPosition(lat, lon, zoom) {
+    doSWF(lat, lon, zoom || 15);
+  }
+</script>
diff --git a/app/views/site/edit.html.erb b/app/views/site/edit.html.erb
index e5bffd1e4..b89184404 100644
--- a/app/views/site/edit.html.erb
+++ b/app/views/site/edit.html.erb
@@ -19,78 +19,9 @@
 <%= render :partial => 'sidebar', :locals => { :onopen => "resizeMap();", :onclose => "resizeMap();" } %>
 <%= render :partial => 'search' %>
 
-<%
-session[:token] = @user.tokens.create.token unless session[:token] and UserToken.find_by_token(session[:token])
+<%= render :partial => @preferred_editor %>
 
-# Decide on a lat lon to initialise potlatch with. Various ways of doing this
-if params['lon'] and params['lat']
-	lon =  h(params['lon']) 
-	lat =  h(params['lat']) 
-	zoom =  h(params['zoom'])
-
-elsif params['mlon'] and params['mlat'] 
-	lon =  h(params['mlon']) 
-	lat =  h(params['mlat']) 
-	zoom =  h(params['zoom'])
-	
-elsif params['gpx']
-	#use gpx id to locate (dealt with below)
-	
-elsif cookies.key?("_osm_location")
-	lon,lat,zoom,layers = cookies["_osm_location"].split("|")
-	
-elsif @user and !@user.home_lon.nil? and !@user.home_lat.nil? 
-	lon =  @user.home_lon
-	lat =  @user.home_lat
-
-else
-	#catch all.  Do nothing.  lat=nil, lon=nil
-	#Currently this results in potlatch starting up at 0,0 (Atlantic ocean).
-end
-
-zoom='14' if zoom.nil?
-%>
-
-<div id="map">
-	<%= t 'site.edit.flash_player_required' %>
-</div>
-
-<%= javascript_include_tag 'swfobject.js' %>
 <script type="text/javascript" defer="defer">
-  var brokenContentSize = $("content").offsetWidth == 0;
-  var fo = new SWFObject("/potlatch/potlatch.swf?d="+Math.round(Math.random()*1000), "potlatch", "100%", "100%", "6", "#FFFFFF");
-  // 700,600 for fixed size, 100%,100% for resizable
-  var changesaved=true;
-  var winie=false; if (document.all && window.print) { winie=true; }
-  
-  window.onbeforeunload=function() {
-    if (!changesaved) {
-      return '<%= escape_javascript(t('site.edit.potlatch_unsaved_changes')) %>';
-    }
-  }
-
-  function markChanged(a) { changesaved=a; }
-
-  function doSWF(lat,lon,sc) {
-    if (sc < 11) sc = 11;
-    fo.addVariable('winie',winie);
-    fo.addVariable('scale',sc);
-    fo.addVariable('token','<%= session[:token] %>');
-    if (lat) { fo.addVariable('lat',lat); }
-    if (lon) { fo.addVariable('long',lon); }
-    <% if params['gpx']     %>fo.addVariable('gpx'     ,'<%= h(params['gpx']    ) %>');<% end %>
-    <% if params['way']     %>fo.addVariable('way'     ,'<%= h(params['way']    ) %>');<% end %>
-    <% if params['node']    %>fo.addVariable('node'    ,'<%= h(params['node']   ) %>');<% end %>
-    <% if params['tileurl'] %>fo.addVariable('custombg','<%= h(params['tileurl']) %>');<% end %>
-    fo.write("map");
-  }
-
-  doSWF(<%= lat || 'null' %>,<%= lon || 'null' %>,<%= zoom %>);
-
-  function setPosition(lat, lon, zoom) {
-    doSWF(lat, lon, zoom || 15);
-  }
-
   function resizeContent() {
     var content = $("content");
     var rightMargin = parseInt(getStyle(content, "right"));
diff --git a/app/views/user/account.html.erb b/app/views/user/account.html.erb
index d5bcb3821..f4523c577 100644
--- a/app/views/user/account.html.erb
+++ b/app/views/user/account.html.erb
@@ -66,6 +66,11 @@
     <td><%= f.text_field :languages %></td>
   </tr>
 
+  <tr>
+    <td class="fieldName" valign="top"><%= t 'user.account.preferred editor' %></td>
+    <td><%= f.select :preferred_editor, Editors::ALL_EDITORS.collect { |e| [t('user.account.editor.'+e), e] } %></td>
+  </tr>
+
   <tr>
     <td class="fieldName" valign="top">
       <%= t 'user.account.image' %>
diff --git a/config/example.application.yml b/config/example.application.yml
index ab5c9a846..5533b5195 100644
--- a/config/example.application.yml
+++ b/config/example.application.yml
@@ -57,6 +57,8 @@ standard_settings: &standard_settings
   oauth_10_support: true
   # URL of Nominatim instance to use for geocoding
   nominatim_url: "http://nominatim.openstreetmap.org/"
+  # Default editor
+  default_editor: "potlatch"
 
 development:
   <<: *standard_settings
diff --git a/config/locales/en.yml b/config/locales/en.yml
index deef86307..d5c82a7a2 100644
--- a/config/locales/en.yml
+++ b/config/locales/en.yml
@@ -1235,6 +1235,7 @@ en:
       anon_edits_link_text: "Find out why this is the case."
       flash_player_required: 'You need a Flash player to use Potlatch, the OpenStreetMap Flash editor. You can <a href="http://www.adobe.com/shockwave/download/index.cgi?P1_Prod_Version=ShockwaveFlash">download Flash Player from Adobe.com</a>. <a href="http://wiki.openstreetmap.org/wiki/Editing">Several other options</a> are also available for editing OpenStreetMap.'
       potlatch_unsaved_changes: "You have unsaved changes. (To save in Potlatch, you should deselect the current way or point, if editing in live mode, or click save if you have a save button.)"
+      no_iframe_support: "Your browser doesn't support HTML iframes, which are necessary for this feature."
     sidebar:
       search_results: Search Results
       close: Close
@@ -1640,6 +1641,7 @@ en:
         link text: "what is this?"
       profile description: "Profile Description:"
       preferred languages: "Preferred Languages:"
+      preferred editor: "Preferred Editor:"
       image: "Image:"
       new image: "Add an image"
       keep image: "Keep the current image"
@@ -1656,6 +1658,9 @@ en:
       return to profile: Return to profile
       flash update success confirm needed: "User information updated successfully. Check your email for a note to confirm your new email address."
       flash update success: "User information updated successfully."
+      editor:
+        potlatch: "Potlatch (in-browser editor)"
+        josm:     "JOSM (via remote-control plugin)"
     confirm:
       heading: Confirm a user account
       press confirm button: "Press the confirm button below to activate your account."
diff --git a/db/migrate/20101114011429_add_editor_preference_to_user.rb b/db/migrate/20101114011429_add_editor_preference_to_user.rb
new file mode 100644
index 000000000..7d39cd200
--- /dev/null
+++ b/db/migrate/20101114011429_add_editor_preference_to_user.rb
@@ -0,0 +1,9 @@
+class AddEditorPreferenceToUser < ActiveRecord::Migration
+  def self.up
+    add_column :users, :preferred_editor, :string
+  end
+
+  def self.down
+    remove_column :users, :preferred_editor
+  end
+end
diff --git a/lib/editors.rb b/lib/editors.rb
new file mode 100644
index 000000000..e3e17e535
--- /dev/null
+++ b/lib/editors.rb
@@ -0,0 +1,3 @@
+module Editors 
+  ALL_EDITORS = [ "potlatch", "josm" ]
+end
diff --git a/test/functional/site_controller_test.rb b/test/functional/site_controller_test.rb
index c388870ad..bdd54288e 100644
--- a/test/functional/site_controller_test.rb
+++ b/test/functional/site_controller_test.rb
@@ -1,8 +1,9 @@
 require File.dirname(__FILE__) + '/../test_helper'
 
 class SiteControllerTest < ActionController::TestCase
-  ## Lets check that we can get all the pages without any errors
-  
+  fixtures :users
+
+  ## Lets check that we can get all the pages without any errors  
   # Get the index
   def test_index
     get :index
@@ -39,4 +40,22 @@ class SiteControllerTest < ActionController::TestCase
     assert_template :partial => '_key', :count => count
     assert_template :partial => '_sidebar', :count => count
   end
+
+  # test the right editor gets used when the user hasn't set a preference
+  def test_edit_without_preference
+    get(:edit, nil, { 'user' => users(:public_user).id })
+    assert_response :success
+    assert_template :partial => "_#{DEFAULT_EDITOR}", :count => 1
+  end
+
+  # and when they have...
+  def test_edit_with_preference
+    user = users(:public_user)
+    user.preferred_editor = "josm"
+    user.save!
+
+    get(:edit, nil, { 'user' => user.id })
+    assert_response :success
+    assert_template :partial => "_josm", :count => 1
+  end    
 end
diff --git a/test/unit/user_test.rb b/test/unit/user_test.rb
index ac2bd5e71..7d5f8dced 100644
--- a/test/unit/user_test.rb
+++ b/test/unit/user_test.rb
@@ -138,4 +138,15 @@ class UserTest < ActiveSupport::TestCase
     #Friend.delete(friend)
     #assert_equal 0, Friend.count
   end
+
+  def test_user_preferred_editor
+    user = users(:normal_user)
+    assert_equal nil, user.preferred_editor
+    user.preferred_editor = "potlatch"
+    assert_equal "potlatch", user.preferred_editor
+    user.save!
+
+    user.preferred_editor = "invalid_editor"
+    assert_raise(ActiveRecord::RecordInvalid) { user.save! }
+  end
 end