Changeset 747

Timestamp:

02/18/08 12:01:07 (11 months ago)

Author:

markku

Message:

* Closes #529.
* Added layout print.rhtml for printable pages, with a proper stylesheet.
* Generalized form viewing/printing code so that it can be used in both form/* and customer_interface/* actions.

Files:

• trunk/app/controllers/application.rb (modified) (1 diff)
• trunk/app/controllers/customer_interface_controller.rb (modified) (4 diffs)
• trunk/app/controllers/form_controller.rb (modified) (5 diffs)
• trunk/app/controllers/task_controller.rb (modified) (1 diff)
• trunk/app/helpers/application_helper.rb (modified) (1 diff)
• trunk/app/views/customer_interface/_form_field_values.rhtml (deleted)
• trunk/app/views/customer_interface/view_form.rhtml (modified) (1 diff)
• trunk/app/views/form/_form_field_values.rhtml (added)
• trunk/app/views/form/print_view.rhtml (added)
• trunk/app/views/form/view.rhtml (modified) (1 diff)
• trunk/app/views/form/view_form_image_field.rhtml (moved) (moved from trunk/app/views/customer_interface/view_form_image_field.rhtml)
• trunk/app/views/layouts/print.rhtml (added)
• trunk/app/views/task/print_view.rhtml (modified) (6 diffs)
• trunk/doc/manual/latex/tex/application_section.tex (modified) (1 diff)
• trunk/doc/manual/latex/tex/customer_interface.tex (modified) (1 diff)
• trunk/public/javascripts/print.js (added)
• trunk/public/stylesheets/print.css (added)
• trunk/public/stylesheets/print_task.css (deleted)
• trunk/test/functional/customer_interface_controller_test.rb (modified) (5 diffs)
• trunk/test/functional/form_controller_test.rb (modified) (1 diff)

trunk/app/controllers/application.rb

@@ -701 +701 @@
-    return true
-  end
+
+  # Method: put_form_field_values_to_field_groups
+  # =============================================
+  # Places the form field values of a form to their field groups.
+  # Used to show the form in a similar order as in form filling view.
+  #
+  # Parameters:
+  # -----------
+  # form - A <Form> whose field values are grouped.
+  # include_automatic_field - If is true, automatic field values are included.
+  # check_show_to_customers - If is true, the show_to_customers flag of
+  #                           field values is checked and ones with the flag
+  #                           set to false are completely ignored.
+  #
+  def put_form_field_values_to_field_groups(form, include_automatic_field = true, check_show_to_customers = false)
+    @field_values_in_groups = []
+    @groupless_field_values = []
+    form.form_field_values.each do |field_value|
+      # Check that customer has permission to view the field value.
+      next if check_show_to_customers and not field_value.form_field.show_to_customers
+      next if not include_automatic_field and field_value.form_field.type_code == FormField::AUTOMATIC
+
+      group = field_value.form_field.form_field_group
+      if group
+        elem = nil
+        @field_values_in_groups.each { |g| elem = g if g[:group].id == group.id}
+        if elem
+          elem[:field_values].push(field_value)
+        else
+          @field_values_in_groups.push({ :group => group, :field_values => [field_value] })
+        end
+      else
+        @groupless_field_values.push(field_value)
+      end
+    end
+    # Sort field groups and field values
+    @field_values_in_groups.sort! { |a,b| a[:group].place <=> b[:group].place }
+    @field_values_in_groups.each { |g| g[:field_values].sort! { |a,b| a.form_field.place <=> b.form_field.place } }
+    @groupless_field_values.sort! { |a,b| a.form_field.place <=> b.form_field.place }
+  end
-end

trunk/app/controllers/customer_interface_controller.rb

@@ -24 +24 @@
-  prepend_before_filter :login_required
-  skip_before_filter :set_selected_asset, :prepare_tree_view, :check_new_service_requests
-
+
+
-
-  # Method: index
@@ -280 +281 @@
-  #
-  def view_form
-    form = Form.find(params[:id])
-
-    unless form.authorized_to_read?
-      info('Unauthorized to view form ID=%d' % form.id)
-      redirect_to(:action => 'index')
-      return
-    end
-
-    @title = _('Filled-out form %s (%s)', form.to_s, form.form_type.name)
-    @show_login_name_link = session[:user].instance_of?(Customer)
-
-    # Place the field values to their field groups.
-    @field_values_in_groups = []
-    @groupless_field_values = []
-    form.form_field_values.each do |field_value|
-      # Check that customer has permission to view the field value.
-      next unless field_value.form_field.show_to_customers
-
-      group = field_value.form_field.form_field_group
-      if group
-        elem = nil
-        @field_values_in_groups.each { |g| elem = g if g[:group].id == group.id}
-        if elem
-          elem[:field_values].push(field_value)
-        else
-          @field_values_in_groups.push({ :group => group, :field_values => [field_value] })
-        end
-      else
-        @groupless_field_values.push(field_value)
-      end
-    end
-    # Sort field groups and field values
-    @field_values_in_groups.sort! { |a,b| a[:group].place <=> b[:group].place }
-    @field_values_in_groups.each { |g| g[:field_values].sort! { |a,b| a.form_field.place <=> b.form_field.place } }
-    @groupless_field_values.sort! { |a,b| a.form_field.place <=> b.form_field.place }
-  end
-
@@ -324 +291 @@
-  def view_form_image_field
-    @value = FormFieldImageValue.find(params[:id])
-
+
+
+
+
+
+
+
+
+
+
-  end
-
@@ -343 +319 @@
-    @assets.sort! { |a, b| a.full_code <=> b.full_code }
-  end
+
+  # Method: get_form_for_viewing
+  # ============================
+  # Find a form for viewing or printing.
+  #
+  def get_form_for_viewing
+    begin
+      @form = Form.find(params[:id])
+
+      unless @form.authorized_to_read?
+        info('Unauthorized to view @form ID:%d' % @form.id)
+        redirect_to(:action => 'index')
+      else
+        info('Displaying form ID:%d' % @form.id)
+        @title = _('Filled-out form %s (%s)', @form.to_s, @form.form_type.name)
+        put_form_field_values_to_field_groups(@form, false, true)
+      end
+    rescue ActiveRecord::RecordNotFound
+      redirect_with_error_message(msg_non_existing_data(Form, params[:id]), :action => 'index')
+    end
+  end
-end

trunk/app/controllers/form_controller.rb

@@ -13 +13 @@
-class FormController < ApplicationController
-  prepend_before_filter :login_required
+  before_filter :get_form_for_viewing, :only => [:view, :print_view]
+  skip_before_filter :set_selected_asset, :prepare_tree_view, :check_new_service_requests, :only => ['get_image_field', 'view_form_image_field']
-
-  LOCK_DURATION = 1.hour
@@ -337 +339 @@
-  # Displays the form in html.
-  def view
-    begin
-      @form = Form.find(params[:id], :include => [:data_permissions, :asset])
-    rescue ActiveRecord::RecordNotFound
-      if params[:cmms_link]
-        redirect_with_error_message(msg_invalid_link_in_markup("[#{params[:id]}]"), :back)
-      else
-        redirect_with_error_message(msg_non_existing_data(Form, params[:id]), :action => 'list')
-      end
-      return
-    end
-
-    unless @form.authorized_to_read?
-      redirect_with_error_message(msg_unauthorized_operation('read', @form.id), :action => 'list')
-      return
-    end
-
-    @title = _('Filled-out form %s (%s)', @form.to_s, @form.form_type.name)
-    info("Displaying form ID:#{params[:id]}")
-
-    @associated_tasks = (@form.opened_tasks + @form.closed_tasks).uniq
-    @task_types = TaskType.find(:all, :readonly => true)
@@ -412 +395 @@
-  # Can be requested by both User and Customer.
-  #
-'customer_interface/view_form'
+['customer_interface/view_form', 'form/view']
-  def get_image_field
-    field = FormFieldImageValue.find(params[:id])
@@ -456 +439 @@
-      end
-      }
+  end
+
+  # Method: print_view
+  # ==================
+  # Simple view for viewing and printing forms.
+  #
+  require_key_for :print_view, 'form/view'
+  def print_view
+    put_form_field_values_to_field_groups(@form, true)
+    render :layout => 'print'
+  end
+
+  # Method: view_form_image_field
+  # =============================
+  # Displays a form image field.
+  #
+  require_key_for :view_form_image_field, 'form/view'
+  def view_form_image_field
+    @value = FormFieldImageValue.find(params[:id])
+    render :layout => false
-  end
-
@@ -535 +538 @@
-    end
-  end
+
+  # Method: get_form_for_viewing
+  # ============================
+  # Find a form for viewing (or printing).
+  #
+  def get_form_for_viewing
+    begin
+      @form = Form.find(params[:id], :include => [:data_permissions, :asset])
+
+      unless @form.authorized_to_read?
+        redirect_with_error_message(msg_unauthorized_operation('read', @form.id), :action => 'list')
+      else
+        @title = _('Filled-out form %s (%s)', @form.to_s, @form.form_type.name)
+        info('Displaying form ID:%d' % @form.id)
+      end
+    rescue ActiveRecord::RecordNotFound
+      if params[:cmms_link]
+        redirect_with_error_message(msg_invalid_link_in_markup("[#{params[:id]}]"), :back)
+      else
+        redirect_with_error_message(msg_non_existing_data(Form, params[:id]), :action => 'list')
+      end
+    end
+  end
-end

trunk/app/controllers/task_controller.rb

@@ -420 +420 @@
-    define_priority_options
-    @assigned_workers = @task.workers
-false
+'print'
-  end
-

trunk/app/helpers/application_helper.rb

@@ -828 +828 @@
-    end
-  end
+
+  # Method: form_field_value
+  # =========================
+  # Format an form field value for views.
+  #
+  # Returns nil for image field values.
+  #
+  def form_field_value(field_value)
+    case field_value.class.to_s
+      when 'FormFieldIntValue', 'FormFieldFloatValue'
+        h(field_value.value.to_s)
+      when 'FormFieldStringValue', 'FormFieldLongStringValue', 'FormFieldEnumValue'
+        h(field_value.value)
+      when 'FormFieldBoolValue'
+        field_value.value ? _('Yes') : _('No')
+      when 'FormFieldDateValue', 'FormFieldDatetimeValue'
+        Localization.format_date(field_value.value)
+      when 'FormFieldTimeValue'
+        Localization.format_time(field_value.value)
+      when 'FormFieldImageValue'
+        nil
+      else
+        raise "Unknown form field value type: #{field_value.class}"
+    end
+  end
-end

trunk/app/views/customer_interface/view_form.rhtml

@@ -2 +2 @@
-  <% for values in @field_values_in_groups -%>
-    <h3><%= h(values[:group].name) %></h3>
-
+/form
-  <% end -%>
-  </br>
-  <% unless @groupless_field_values.empty? -%>
-    <div class="vspace"></div>
-
+/form
-  <% end -%>
-</div>
+<table class="actions">
+  <tr>
+    <td><%= link_to(image_tag('16x16/print.gif') + _('Printer-friendly'),
+                    {:action => 'print_form', :id => @form.id}, :popup => true) %></td>
+  </tr>
+</table>
-</br>
-<%= link_to(_('Back'), :controller => 'customer_interface', :action => 'index') %>

trunk/app/views/form/view.rhtml

@@ -43 +43 @@
-    <td><%= link_to(image_tag('16x16/download.png') + _('Download'),
-                    {:action => 'download', :id => @form.id}) %></td>
+    <td><%= link_to(image_tag('16x16/print.gif') + _('Printer-friendly'),
+                    {:action => 'print_view', :id => @form.id}, :popup => true) %></td>
-  </tr>
-</table>

trunk/app/views/task/print_view.rhtml

@@ -1 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<%
-link_url = {
@@ -7 +6 @@
-           }
--%>
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-  <title><%= h(@title) + ' - NorfelloCMMS' %></title>
-  <%= stylesheet_link_tag 'print_task' %>
-
-  <%= javascript_include_tag 'prototype' %>
-  <script type="text/javascript">
-    function show(sv, obj) {
-      if(sv)
-        $(obj).style.visibility = 'visible';
-      else
-        $(obj).style.visibility = 'hidden';
-    }
-
-    function print_task() {
-      var e = $('printlink');
-      show(false, e);
-      window.print();
-      // XXX: It would be nice to show the element again after printing.
-      //show(true, e);
-    }
-
-    function add_print_link(obj) {
-      $(obj).innerHTML = '<hr/><a href="javascript:print_task()"><%= image_tag("16x16/print.gif") + " " + _("Print") %></a>';
-    }
-  </script>
-</head>
-
-<body onload="add_print_link('printlink')">
-<div id="print_task">
-<h1><%= @title %></h1>
-
-<table>
-  <tr>
@@ -86 +53 @@
-
-<h2><%= _('Asset information') %></h2>
-
+, {:class=>'hide_show'}
-<% unless @hide_asset_information -%>
-
+
+
-    <tr>
-%= _('Code') %
+div><%= _('Code') %></div
-      <td><%= h(@task.asset.full_code) %></td>
-    </tr>
-    <tr>
-%= _('Name') %
+div><%= _('Name') %></div
-      <td><%= h(@task.asset.name) %></td>
-    </tr>
-    <% if @task.asset.customer -%>
-    <tr>
-%= _('Customer') %
+div><%= _('Customer') %></div
-      <td><%= h(@task.asset.customer.name) %></td>
-    </tr>
@@ -105 +73 @@
-    <% if @task.asset.asset_type -%>
-    <tr>
-%= _('Asset type') %
+div><%= _('Asset type') %></div
-      <td><%= h(@task.asset.asset_type.name) %></td>
-    </tr>
-    <% for field_value in @task.asset.asset_field_values -%>
-      <tr>
-%= h(field_value.asset_field.name) %
+div><%= h(field_value.asset_field.name) %></div
-        <td><%= asset_field_value(field_value) %></td>
-      </tr>
@@ -126 +94 @@
-<% unless @task.task_events.empty? -%>
-  <h2><%= _('Change history') %></h2>
-
+, {:class=>'hide_show'}
-  <% unless @hide_history -%>
-  <div id="print_task_history">
@@ -137 +105 @@
-  <% end -%>
-<% end -%>
-<div id="printlink"></div>
-</div>
-</body>
-</html>

trunk/doc/manual/latex/tex/application_section.tex

@@ -318 +318 @@
-\item[Permissions:] Shows you the data permissions for the form, which define what user groups are authorized to do to the form. Form permissions include viewing and editing permissions. You can also edit the data permissions if you have the editing permission to the form.
-\item[Download:] Offers the form to be downloaded as an Open Document file.
+\item[Printer friendly] Shows the filled form in a simplyfied view that is suited for printing with your web-browser.
-\end{description}
-\paragraph{Search}

trunk/doc/manual/latex/tex/customer_interface.tex

@@ -23 +23 @@
-Customers can view filled forms by selecting them from the timeline.
-
+At the bottom of the form viewing page, right above the 'Back' link, there is a link 'Printer friendly' that opens a page that is more suitable for printing with your web-browser.
+
-Each field of each form type can be configured --- in the Form type menu of the Configuration section \ref{subsec:form_types} --- to be viewable for customers.
-\subsubsection{Submit a service request}

trunk/test/functional/customer_interface_controller_test.rb

@@ -27 +27 @@
-    @user_group_root.form_permission_profiles(:other => true, :group_read => true, :group_edit => true)
-    @user_group_root.attachment_permission_profiles(:other => true, :group_read => true, :group_edit => true)
+  end
+
+  # Method: setup_test_form
+  # =======================
+  # Setup a test form type and create a form for it.
+  #
+  def setup_test_form
+    # Form type
+    @form_type = FormType.create!(:name => 'Test type', :editable => false, :ready => true)
+    # Form field groups
+    @ffg1 = @form_type.form_field_groups.create(:name => 'First', :place => 1)
+    @ffg2 = @form_type.form_field_groups.create(:name => 'Second', :place => 2)
+    # Form fields visible to customers
+    @ff1 = @form_type.form_fields.create(:name => 'Integer', :user_field_name => 'int', :type_code => FormField::INTEGER, :form_field_group => @ffg2, :show_to_customers => true, :show_to_customers => true, :place => 1)
+    @ff2 = @form_type.form_fields.create(:name => 'String', :user_field_name => 'string', :type_code => FormField::STRING, :form_field_group => @ffg2, :show_to_customers => true, :place => 2)
+    @ff3 = @form_type.form_fields.create(:name => 'Boolean', :user_field_name => 'bool', :type_code => FormField::BOOLEAN, :form_field_group => @ffg1, :show_to_customers => true, :place => 2)
+    @ff4 = @form_type.form_fields.create(:name => 'Float', :user_field_name => 'float', :type_code => FormField::FLOAT, :form_field_group => @ffg1, :show_to_customers => true, :place => 1)
+    @ff5 = @form_type.form_fields.create(:name => 'Long string', :user_field_name => 'lstring', :type_code => FormField::LONG_STRING, :show_to_customers => true, :place => 4)
+    @ff6 = @form_type.form_fields.create(:name => 'Date', :user_field_name => 'date', :type_code => FormField::DATE, :show_to_customers => true, :place => 3)
+    @ff7 = @form_type.form_fields.create(:name => 'Time', :user_field_name => 'time', :type_code => FormField::TIME, :show_to_customers => true, :place => 2)
+    @ff8 = @form_type.form_fields.create(:name => 'Datetime', :user_field_name => 'datetime', :type_code => FormField::DATETIME, :show_to_customers => true, :place => 1)
+    @ff9 = @form_type.form_fields.create(:name => 'Automatic 1', :user_field_name => 'cmms_form_id', :type_code => FormField::AUTOMATIC, :show_to_customers => true)
+    # Form fields hidden from customers
+    @form_type.form_fields.create(:name => 'Integer 2', :user_field_name => 'int2', :type_code => FormField::INTEGER)
+    @form_type.form_fields.create(:name => 'String 2', :user_field_name => 'string2', :type_code => FormField::STRING)
+    @form_type.form_fields.create(:name => 'Boolean 2', :user_field_name => 'bool2', :type_code => FormField::BOOLEAN)
+    @form_type.form_fields.create(:name => 'Float 2', :user_field_name => 'float2', :type_code => FormField::FLOAT)
+    @form_type.form_fields.create(:name => 'Long string 2', :user_field_name => 'lstring2', :type_code => FormField::LONG_STRING)
+    @form_type.form_fields.create(:name => 'Date 2', :user_field_name => 'date2', :type_code => FormField::DATE, :form_field_group => @ffg1)
+    @form_type.form_fields.create(:name => 'Time 2', :user_field_name => 'time2', :type_code => FormField::TIME, :form_field_group => @ffg2)
+    @form_type.form_fields.create(:name => 'Datetime 2', :user_field_name => 'datetime2', :type_code => FormField::DATETIME)
+    @form_type.form_fields.create(:name => 'Automatic 2', :user_field_name => 'cmms_form_type_name', :type_code => FormField::AUTOMATIC)
+    @form_type.save!
+
+    # Test form
+    @root.customer = @customer
+    @root.save!
+    @form = @form_type.create_empty_form(@root)
+    @form.ready = true
+    @form.save!
+    @form.update_automatic_field_values
-  end
-
@@ -503 +544 @@
-  end
-
+  # Method: test_view_form_unauthorized
+  # ===================================
+  # Checks that form viewing is denied from unauthorized customers.
+  #
+  def test_view_form_unauthorized
+    setup_test_form
+
+    unauthorized_customer = create_customer('unauthorized')
+    login(unauthorized_customer.login)
+
+    # The current customer does not own the asset, so he is unauthorized to
+    # view the form in it. Thus he is silently redirected to index.
+    get 'view_form', :id => @form.id
+    assert_redirected_to :action => 'index'
+    assert_nil flash[:error]
+    assert_nil flash[:notice]
+    assert_nil assigns(:field_values)
+  end
+
-  # Method: test_view_form
-  # ======================
@@ -508 +568 @@
-  #
-  def test_view_form
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    unauthorized_customer = create_customer('unauthorized')
@@ -547 +616 @@
-
-    # The current customer does not own the asset, so he is unauthorized to
-view
-view_form', :id => 
+print
+print_form', :id => @
-    assert_redirected_to :action => 'index'
-    assert_nil flash[:error]
-    assert_nil flash[:notice]
-    assert_nil assigns(:field_values)
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-    field_values_in_groups = assigns(:field_values_in_groups)
@@ -569 +644 @@
-
-    first_group = field_values_in_groups.first
-
+@ff
-    assert_equal 2, first_group[:field_values].size
-
-
+@f
+@f
-
-    last_group = field_values_in_groups.last
-
+@ff
-    assert_equal 2, last_group[:field_values].size
-
-
+@f
+@f
-
-    groupless_field_values = assigns(:groupless_field_values)
-
-
-
-
-
-
+
+
+
+
+
+
+
-  end
-

trunk/test/functional/form_controller_test.rb

@@ -273 +273 @@
-  end
-
+  # Method: test_print_view
+  # =======================
+  # Check the print_view action works.
+  def test_print_view
+    @keyring.action_keys << create_action_key('form/view')
+    login('test')
+
+    setup_simple_form_type
+    setup_test_forms
+
+    get 'print_view', :id => @form1.id
+    assert_response :success
+    assert_template 'print_view'
+    assert_equal @form1, assigns(:form)
+    assert_equal [], assigns(:field_values_in_groups)
+    assert_equal @form1.form_field_values.size, assigns(:groupless_field_values).size
+    assigns(:groupless_field_values).each { |v|
+      assert_equal true, @form1.form_field_values.include?(v)
+    }
+  end
+
-  private
-