Changeset 739

Timestamp:

01/17/08 15:57:43 (1 year ago)

Author:

markku

Message:

Closes #523.

Files:

• trunk/app/controllers/customer_interface_controller.rb (modified) (1 diff)
• trunk/app/controllers/form_controller.rb (modified) (1 diff)
• trunk/app/helpers/customer_interface_helper.rb (modified) (1 diff)
• trunk/app/models/customer.rb (modified) (1 diff)
• trunk/app/models/form.rb (modified) (1 diff)
• trunk/app/views/customer_interface/_form_field_values.rhtml (added)
• trunk/app/views/customer_interface/view_form.rhtml (added)
• trunk/app/views/customer_interface/view_form_image_field.rhtml (added)
• trunk/app/views/form_type/create_step4.rhtml (modified) (2 diffs)
• trunk/app/views/form_type/edit.rhtml (modified) (2 diffs)
• trunk/db/migrate/014_show_form_fields_to_customers.rb (added)
• trunk/doc/manual/latex/tex/configuration_section.tex (modified) (1 diff)
• trunk/doc/manual/latex/tex/customer_interface.tex (modified) (2 diffs)
• trunk/public/stylesheets/customer_interface_timeline.css (modified) (2 diffs)
• trunk/test/functional/customer_interface_controller_test.rb (modified) (1 diff)
• trunk/test/unit/form_test.rb (modified) (1 diff)

trunk/app/controllers/customer_interface_controller.rb

@@ -275 +275 @@
-  end
-
+  # Method: view_form
+  # =================
+  # View a filled form.
+  #
+  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
+
+  # Method: view_form_image_field
+  # =============================
+  # Displays a form image field.
+  #
+  require_key_for :view_form_image_field, 'customer_interface/view_form'
+  def view_form_image_field
+    @value = FormFieldImageValue.find(params[:id])
+    render :layout => false
+  end
+
-  protected
-

trunk/app/controllers/form_controller.rb

@@ -406 +406 @@
-  end
-
+  # Method: get_image_field
+  # =======================
+  # Displays an image field from a form.
+  #
+  # Can be requested by both User and Customer.
+  #
+  require_key_for :get_image_field, 'customer_interface/view_form'
+  def get_image_field
+    field = FormFieldImageValue.find(params[:id])
+    authorized = field.form.authorized_to_read?
+    authorized = field.form_field.show_to_customers if UserAccount.current_user.instance_of?(Customer) and authorized
+    if authorized
+      send_data(field.get_filled_image.data)
+    else
+      error('Unauthorized to display image field from the form ID=%d' % form.id)
+      render :text => ''
+    end
+  end
+
-  # Function: download
-  # ==================

trunk/app/helpers/customer_interface_helper.rb

@@ -70 +70 @@
-    content = "#{form.to_s} (#{form.form_type.name})"
-    content = _('Form') + ' ' + content unless no_text
+
+    return link_to(content, { :controller => 'customer_interface', :action => 'view_form', :id => form.id }, { :class => 'form', :title => _('View form %s', form.to_s) }) if form.authorized_to_read?
-    return span_tag('form', content)
-  end

trunk/app/models/customer.rb

@@ -36 +36 @@
-                 'customer_interface/edit_my_information',
-                 'customer_interface/change_password',
-
+
+
-                ]
-

trunk/app/models/form.rb

@@ -183 +183 @@
-  end
-
+  # See superclasses for description
+  def authorized_to_read?
+    return super unless UserAccount.current_user.instance_of?(Customer)
+
+    # Customer can read a form in her asset if the form has fields that
+    # are configured to be shown to customers.
+    return false unless self.asset.authorized_to_read?
+    self.form_field_values.each { |field|
+      return true if field.form_field.show_to_customers
+    }
+    return false
+  end
+
-protected
-

trunk/app/views/form_type/create_step4.rhtml

@@ -110 +110 @@
-          <%= _("Can't be empty") %>
-        </th>
+        <th>
+          <%= _('Show to customers') %>
+        </th>
-      </tr>
-      <% for @field in @fields -%>
@@ -142 +145 @@
-          <td><%= check_box("field[]", "validate_presence") %></td>
-        <% end -%>
+        <% if @field.type_code == FormField::AUTOMATIC            -%>
+          <td></td>
+        <% else-%>
+          <td><%= check_box("field[]", "show_to_customers") %></td>
+        <% end -%>
-      </tr>
-    <% end -%>

trunk/app/views/form_type/edit.rhtml

@@ -29 +29 @@
-        <%= _("Can't be empty") %>
-      </th>
+      <th>
+        <%= _('Show to customers') %>
+      </th>
-    </tr>
-    <% for @field in @fields -%>
@@ -45 +48 @@
-        </td>
-      <% end -%>
+      <td>
+        <%= check_box("field[]", "show_to_customers") %>
+      </td>
-    </tr>
-    <% end -%>

trunk/doc/manual/latex/tex/configuration_section.tex

@@ -193 +193 @@
-\item \textbf{Show in form list}: Checking this defines the field to shown in the form list
-\item \textbf{Can't be empty}: Checking this defines the field to be a mandatory field, which can't be left empty
+\item \textbf{Show to customers}: This option enables you show the content of the form field to your customers. Checking this option defines the form field to be shown to your customers in the Customer interface --- See the section~\ref{sec:customer_interface} for the Customer interface.
-\end{itemize}
-The 'Preview' link enables you to preview the filling form. To finish the configuration select the 'Finish' button.

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

@@ -5 +5 @@
-\item View their assets
-\item View timeline that shows activity in their assets
+\item View filled forms in their assets
-\item Submit service requests
-\item View and follow their open service request
@@ -19 +20 @@
-
-\subsection{Functions in the Customer interface}
+\subsubsection{View a filled form}
+Customers can view filled forms by selecting them from the timeline.
+
+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}
-Customers can submit service requests with this function. The service request will show up in the service request list in the Tasks menu found from the Application section. If a customer doesn't select an asset for the a service request, the service request will be saved to the customer's first asset --- You can move it to another asset if you wish.
-\subsubsection{Comment service request}
-
+selecting the service request from the list of open service requests. This opens a commenting form that can be submitted as usual. When the comment is successfully received it will show up in the timeline.
-\subsubsection{My information}
-Customers can view and edit their contact information and language by clicking the account name link after the 'Logged in as:' text at the top of the page.

trunk/public/stylesheets/customer_interface_timeline.css

@@ -3 +3 @@
- */
-
-
+, a.form
-        padding-left: 20px;
-        background: transparent url(../images/16x16/timeline_form.gif) 0px 0px no-repeat;
@@ -17 +17 @@
-        background: transparent url(../images/16x16/timeline_attachment.gif) 0px 0px no-repeat;
-}
+
+/*
+ * Viewing filled forms through timeline
+ */
+
+div.filled_form {
+    background: #fff;
+    border: 5px solid #fff;
+    border-bottom: 0px;
+}
+
+div.filled_form h3 {
+    padding-bottom: 0.2em;
+}
+
+table.form_field_values th {
+    background: #ddf;
+    padding: 0.3em;
+    border-bottom: 5px solid #fff;
+    width: 5em;
+    white-space: nowrap;
+}
+
+table.form_field_values div {
+    white-space: nowrap;
+}
+
+table.form_field_values td {
+    background: #eef;
+    padding: 0.3em;
+    border-bottom: 5px solid #fff;
+    padding-right: 0.4em;
+}
+
+div.vspace {
+    height: 1em;
+}

trunk/test/functional/customer_interface_controller_test.rb

@@ -503 +503 @@
-  end
-
+  # Method: test_view_form
+  # ======================
+  # Checks that form viewing works.
+  #
+  def test_view_form
+    # Form type
+    form_type = FormType.create!(:name => 'Test type', :editable => false, :ready => true)
+    # Form field groups
+    g1 = form_type.form_field_groups.create(:name => 'First', :place => 1)
+    g2 = form_type.form_field_groups.create(:name => 'Second', :place => 2)
+    # Form fields visible to customers
+    f1 = form_type.form_fields.create(:name => 'Integer', :user_field_name => 'int', :type_code => FormField::INTEGER, :form_field_group => g2, :show_to_customers => true, :show_to_customers => true, :place => 1)
+    f2 = form_type.form_fields.create(:name => 'String', :user_field_name => 'string', :type_code => FormField::STRING, :form_field_group => g2, :show_to_customers => true, :place => 2)
+    f3 = form_type.form_fields.create(:name => 'Boolean', :user_field_name => 'bool', :type_code => FormField::BOOLEAN, :form_field_group => g1, :show_to_customers => true, :place => 2)
+    f4 = form_type.form_fields.create(:name => 'Float', :user_field_name => 'float', :type_code => FormField::FLOAT, :form_field_group => g1, :show_to_customers => true, :place => 1)
+    f5 = form_type.form_fields.create(:name => 'Long string', :user_field_name => 'lstring', :type_code => FormField::LONG_STRING, :show_to_customers => true, :place => 5)
+    f6 = form_type.form_fields.create(:name => 'Date', :user_field_name => 'date', :type_code => FormField::DATE, :show_to_customers => true, :place => 4)
+    f7 = form_type.form_fields.create(:name => 'Time', :user_field_name => 'time', :type_code => FormField::TIME, :show_to_customers => true, :place => 3)
+    f8 = form_type.form_fields.create(:name => 'Datetime', :user_field_name => 'datetime', :type_code => FormField::DATETIME, :show_to_customers => true, :place => 2)
+    f9 = form_type.form_fields.create(:name => 'Automatic 1', :user_field_name => 'cmms_form_id', :type_code => FormField::AUTOMATIC, :show_to_customers => true, :place => 1)
+    # 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 => g1)
+    form_type.form_fields.create(:name => 'Time 2', :user_field_name => 'time2', :type_code => FormField::TIME, :form_field_group => g2)
+    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
+
+    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)
+
+    login(@customer.login)
+
+    # The current customer is authorized to view the form
+    assert_equal true, form.authorized_to_read?
+    get 'view_form', :id => form.id
+    assert_response :success
+    assert_template 'customer_interface/view_form'
+    assert_nil flash[:error]
+    assert_nil flash[:notice]
+    assert_equal true, assigns(:show_login_name_link)
+
+    field_values_in_groups = assigns(:field_values_in_groups)
+    assert_equal 2, field_values_in_groups.size
+
+    first_group = field_values_in_groups.first
+    assert_equal g1, first_group[:group]
+    assert_equal 2, first_group[:field_values].size
+    assert_equal f4, first_group[:field_values].first.form_field
+    assert_equal f3, first_group[:field_values].last.form_field
+
+    last_group = field_values_in_groups.last
+    assert_equal g2, last_group[:group]
+    assert_equal 2, last_group[:field_values].size
+    assert_equal f1, last_group[:field_values].first.form_field
+    assert_equal f2, last_group[:field_values].last.form_field
+
+    groupless_field_values = assigns(:groupless_field_values)
+    assert_equal 5, groupless_field_values.size
+    assert_equal f9, groupless_field_values[0].form_field
+    assert_equal f8, groupless_field_values[1].form_field
+    assert_equal f7, groupless_field_values[2].form_field
+    assert_equal f6, groupless_field_values[3].form_field
+    assert_equal f5, groupless_field_values[4].form_field
+  end
+
-  private
-

trunk/test/unit/form_test.rb

@@ -162 +162 @@
-  # Test automatic asset fields
-
+  # Method: test_customer_authorized_to_read
+  # ========================================
+  # Checks that customers are authorized to read right forms:
+  # Forms that belong to customers asset and have a form field with the
+  # option show_to_customers set to true.
+  #
+  def test_customer_authorized_to_read
+    user = UserAccount.current_user
+    customer = create_customer('customer')
+    UserAccount.current_user = customer
+    assert_equal false, @form.asset.authorized_to_read?
+    assert_equal false, @form.authorized_to_read?
+
+    UserAccount.current_user = user
+    @form.asset.customer = customer
+    @form.asset.save!
+
+    UserAccount.current_user = customer
+    assert_equal true, @form.asset.authorized_to_read?
+    assert_equal false, @form.authorized_to_read?
+
+    # Set a form field visible to customers
+    assert @form.form_field_values.find(:first).form_field.update_attribute(:show_to_customers, true)
+    @form.reload
+    # Now the customer can read the form
+    assert_equal true, @form.asset.authorized_to_read?
+    assert_equal true, @form.authorized_to_read?
+  end
-end