chef-server-webui 0.8.2

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.rdoc

@@ -0,0 +1,135 @@
+= Chef
+
+= DESCRIPTION:
+
+Chef is a configuration management tool designed to bring automation to your entire infrastructure. 
+
+The Chef Wiki is the definitive source of user documentation. 
+
+* http://wiki.opscode.com/display/chef/Home
+
+This README focuses on developers who want to modify Chef source code. For users who just want to run the latest and greatest Chef development version in their environment, see:
+
+* http://wiki.opscode.com/display/chef/Installing+Chef+from+HEAD
+
+= DEVELOPMENT:
+
+Before working on the code, if you plan to contribute your changes, you need to read the Opscode Contributing document.
+
+* http://wiki.opscode.com/display/opscode/Contributing
+
+You will also need to set up the repository with the appropriate branches. We document the process on the Chef Wiki.
+
+* http://wiki.opscode.com/display/opscode/Working+with+Git
+
+Once your repository is set up, you can start working on the code. We do use BDD/TDD with RSpec and Cucumber, so you'll need to get a development environment running.
+
+= ENVIRONMENT:
+
+In order to have a development environment where changes to the Chef code can be tested, we'll need to install a few things after setting up the Git repository.
+
+== Requirements:
+
+Install these via your platform's preferred method; for example apt, yum, ports, emerge, etc.
+
+* Git
+* CouchDB
+* libxml2 development package (for webrat)
+* libxslt develoment package (for webrat)
+
+Install the following RubyGems.
+
+* ohai
+* rake
+* rspec
+* cucumber
+* webrat
+* merb-core
+* roman-merb_cucumber
+
+Ohai is also by Opscode and available on GitHub, http://github.com/opscode/ohai/tree/master.
+
+roman-merb_cucumber is available from GitHub:
+
+  gem install --source http://gems.github.com/ roman-merb_cucumber
+
+== Starting the Environment:
+
+Once everything is installed, run the dev:features rake task. Since the features do integration testing, root access is required.
+
+  sudo rake dev:features
+
+The dev:features task:
+
+* Installs chef, chef-server, chef-server-slice gems. It will fail if required gems above are missing.
+* Starts chef-server on ports 4000 and 4001.
+* Starts chef-indexer.
+* Starts CouchDB on port 5984.
+* Starts the stompserver on port 61613.
+
+You'll know its running when you see:
+
+   ~ Activating slice 'ChefServerSlice' ...
+  merb : worker (port 4000) ~ Starting Mongrel at port 4000
+  merb : worker (port 4000) ~ Successfully bound to port 4000
+  merb : worker (port 4001) ~ Starting Mongrel at port 4001
+  merb : worker (port 4001) ~ Successfully bound to port 4001
+
+You'll want to leave this terminal running the dev environment.
+
+== Web Interface:
+
+With the dev environment running, you can now access the web interface via http://localhost:4000/. Supply an OpenID to log in.
+
+== Spec testing:
+
+We use RSpec for unit/spec tests.
+
+  rake spec
+
+This doesn't actually use the development environment, because it does the testing on all the Chef internals. For integration/usage testing, we use Cucumber features.
+
+== Integration testing:
+
+We test integration with Cucumber. The available feature tests are rake tasks:
+
+  rake features                            # Run Features with Cucumber
+  rake features:api                        # Run Features with Cucumber
+  rake features:client                     # Run Features with Cucumber
+  rake features:provider:package:macports  # Run Features with Cucumber
+  rake features:provider:remote_file       # Run Features with Cucumber
+  rake features:search                     # Run Features with Cucumber
+
+= LINKS:
+
+Source:
+
+* http://github.com/opscode/chef/tree/master
+
+Tickets/Issues:
+
+* http://tickets.opscode.com/
+
+Documentation:
+
+* http://wiki.opscode.com/display/chef/Home/
+
+= LICENSE:
+
+Chef - A configuration management system
+
+Author:: Adam Jacob (<adam@opscode.com>)
+Copyright:: Copyright (c) 2008, 2009 Opscode, Inc.
+License:: Apache License, Version 2.0
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "chef-server-webui"
+CHEF_SERVER_VERSION="0.8.2"
+AUTHOR = "Opscode"
+EMAIL = "chef@opscode.com"
+HOMEPAGE = "http://wiki.opscode.com/display/chef"
+SUMMARY = "A systems integration framework, built to bring the benefits of configuration management to your entire infrastructure."
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM_NAME
+  s.version = CHEF_SERVER_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE" ]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+
+  ["merb-slices",
+   "merb-core",
+   "merb-haml",
+   "merb-assets",
+   "merb-helpers",
+   "merb-param-protection",
+   "thin",
+   "haml",
+   "json",
+   "ruby-openid",
+   "coderay"].each { |g| s.add_dependency g}
+  
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README.rdoc Rakefile config.ru) + Dir.glob("{bin,config,lib,spec,app,public,stubs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem"
+task :install => :package do
+  sh %{gem install pkg/#{GEM_NAME}-#{CHEF_SERVER_VERSION} --no-rdoc --no-ri}
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  sh %{gem uninstall #{GEM_NAME} -x -v #{CHEF_SERVER_VERSION} }
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+

data/app/controllers/application.rb

@@ -0,0 +1,281 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: Christopher Brown (<cb@opscode.com>)
+# Author:: Nuo Yan (<nuo@opscode.com>)
+# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require "chef" / "mixin" / "checksum"
+require "chef" / "cookbook_loader"
+
+class ChefServerWebui::Application < Merb::Controller
+
+  include Chef::Mixin::Checksum
+
+  controller_for_slice
+  
+  # Generate the absolute url for a slice - takes the slice's :path_prefix into account.
+  #
+  # @param slice_name<Symbol> 
+  #   The name of the slice - in identifier_sym format (underscored).
+  # @param *args<Array[Symbol,Hash]> 
+  #   There are several possibilities regarding arguments:
+  #   - when passing a Hash only, the :default route of the current 
+  #     slice will be used
+  #   - when a Symbol is passed, it's used as the route name
+  #   - a Hash with additional params can optionally be passed
+  # 
+  # @return <String> A uri based on the requested slice.
+  #
+  # @example absolute_slice_url(:awesome, :format => 'html')
+  # @example absolute_slice_url(:forum, :posts, :format => 'xml')          
+  def absolute_slice_url(slice_name, *args)
+    options  = extract_options_from_args!(args) || {}
+    protocol = options.delete(:protocol) || request.protocol
+    host     = options.delete(:host) || request.host
+    
+    protocol + "://" + host + slice_url(slice_name,*args)
+  end
+  
+  # Check if the user is logged in and if the user still exists
+  def login_required
+   if session[:user]
+     begin
+       Chef::WebUIUser.load(session[:user]) rescue (raise NotFound, "Cannot find User #{session[:user]}, maybe it got deleted by an Administrator.")
+     rescue   
+       logout_and_redirect_to_login
+     else 
+       return session[:user]
+     end 
+   else  
+     self.store_location
+     throw(:halt, :access_denied)
+   end
+  end
+  
+  def cleanup_session
+    [:user,:level].each { |n| session.delete(n) }
+  end 
+  
+  def logout_and_redirect_to_login
+    cleanup_session
+    @user = Chef::WebUIUser.new
+    redirect(slice_url(:users_login), {:message => { :error => $! }, :permanent => true})
+  end 
+  
+  
+  def is_admin(name)
+    user = Chef::WebUIUser.load(name)
+    return user.admin
+  end
+  
+  #return true if there is only one admin left, false otehrwise
+  def is_last_admin
+    count = 0
+    users = Chef::WebUIUser.list
+    users.each do |u, url|
+      user = Chef::WebUIUser.load(u)
+      if user.admin
+        count = count + 1
+        return false if count == 2
+      end
+    end
+    true
+  end
+  
+  #whether or not the user should be able to edit a user's admin status
+  def edit_admin
+    is_admin(params[:user_id]) ? (!is_last_admin) : true
+  end 
+  
+  def authorized_node
+  #  if session[:level] == :admin
+  #    Chef::Log.debug("Authorized as Administrator")
+  #    true
+  #  elsif session[:level] == :node
+  #    Chef::Log.debug("Authorized as node")
+  #    if session[:node_name] == params[:id].gsub(/\./, '_')
+  #      true
+  #    else
+  #      raise(
+  #        Unauthorized,
+  #        "You are not the correct node for this action: #{session[:node_name]} instead of #{params[:id]}"
+  #      )
+  #    end
+  #  else
+  #    Chef::Log.debug("Unauthorized")
+  #    raise Unauthorized, "You are not allowed to take this action."
+  #  end
+  end
+  
+  def authorized_user
+    if session[:level] == :admin
+      Chef::Log.debug("Authorized as Administrator")
+      true
+    else
+      Chef::Log.debug("Unauthorized")
+      raise Unauthorized, "The current user is not an Administrator, you can only Show and Edit the user itself. To control other users, login as an Administrator."
+    end 
+  end 
+  
+  # Store the URI of the current request in the session.
+  #
+  # We can return to this location by calling #redirect_back_or_default.
+  def store_location
+    session[:return_to] = request.uri
+  end
+
+  # Redirect to the URI stored by the most recent store_location call or
+  # to the passed default.
+  def redirect_back_or_default(default)
+    loc = session[:return_to] || default
+    session[:return_to] = nil
+    redirect loc
+  end
+  
+  def access_denied
+    case content_type
+    when :html
+      store_location
+      redirect slice_url(:users_login), :message => { :error => "You don't have access to that, please login."}
+    else
+      raise Unauthorized, "You must authenticate first!"
+    end
+  end
+  
+  # Load a cookbook and return a hash with a list of all the files of a 
+  # given segment (attributes, recipes, definitions, libraries)
+  #
+  # === Parameters
+  # cookbook_id<String>:: The cookbook to load
+  # segment<Symbol>:: :attributes, :recipes, :definitions, :libraries
+  #
+  # === Returns
+  # <Hash>:: A hash consisting of the short name of the file in :name, and the full path
+  #   to the file in :file.
+  def load_cookbook_segment(cookbook_id, segment)    
+    r = Chef::REST.new(Chef::Config[:chef_server_url])
+    cookbook = r.get_rest("cookbooks/#{cookbook_id}")
+
+    raise NotFound unless cookbook
+    
+    files_list = segment_files(segment, cookbook)
+    
+    files = Hash.new
+    files_list.each do |f|
+      files[f['name']] = {
+        :name => f["name"],
+        :file => f["uri"],
+      }
+    end
+    files
+  end
+  
+  def segment_files(segment, cookbook)
+    files_list = nil
+    case segment
+    when :attributes
+      files_list = cookbook["attributes"]
+    when :recipes
+      files_list = cookbook["recipes"]
+    when :definitions
+      files_list = cookbook["definitions"]
+    when :libraries
+      files_list = cookbook["libraries"]
+    else
+      raise ArgumentError, "segment must be one of :attributes, :recipes, :definitions or :libraries"
+    end
+    files_list
+  end
+
+  #
+  # The following should no longer be necessary for the re-factored cookbooks replated webui controllers (which talks to the API) 
+  # But I want to wait until further verified before removing the code. [nuo]
+  #
+  # def specific_cookbooks(node_name, cl)
+  #   valid_cookbooks = Hash.new
+  #   begin
+  #     node = Chef::Node.load(node_name)
+  #     recipes, default_attrs, override_attrs = node.run_list.expand
+  #   rescue Net::HTTPServerException
+  #     recipes = []
+  #   end
+  #   recipes.each do |recipe|
+  #     valid_cookbooks = expand_cookbook_deps(valid_cookbooks, cl, recipe)
+  #   end
+  #   valid_cookbooks
+  # end
+  # 
+  # def expand_cookbook_deps(valid_cookbooks, cl, recipe)
+  #   cookbook = recipe
+  #   if recipe =~ /^(.+)::/
+  #     cookbook = $1
+  #   end
+  #   Chef::Log.debug("Node requires #{cookbook}")
+  #   valid_cookbooks[cookbook] = true 
+  #   cl.metadata[cookbook.to_sym].dependencies.each do |dep, versions|
+  #     expand_cookbook_deps(valid_cookbooks, cl, dep) unless valid_cookbooks[dep]
+  #   end
+  #   valid_cookbooks
+  # end
+  # 
+  # def load_all_files(segment, node_name=nil)
+  #   r = Chef::REST.new(Chef::Config[:chef_server_url])
+  #   cookbooks = r.get_rest("cookbooks")
+  #   
+  #   files = Array.new
+  #   valid_cookbooks = node_name ? specific_cookbooks(node_name, cookbooks) : {} 
+  #   cl.each do |cookbook|
+  #     if node_name
+  #       next unless valid_cookbooks[cookbook.name.to_s]
+  #     end
+  #     segment_files(segment, cookbook).each do |sf|
+  #       mo = sf.match("cookbooks/#{cookbook.name}/#{segment}/(.+)")
+  #       file_name = mo[1]
+  #       files << { 
+  #         :cookbook => cookbook.name, 
+  #         :name => file_name,
+  #         :checksum => checksum(sf)
+  #       }
+  #     end
+  #   end
+  #   files
+  # end
+
+  def get_available_recipes
+    r = Chef::REST.new(Chef::Config[:chef_server_url])
+    result = Array.new
+    cookbooks = r.get_rest("cookbooks")
+    cookbooks.keys.sort.each do |key|
+      cb = r.get_rest(cookbooks[key])
+      cb["recipes"].each do |recipe|
+        recipe["name"] =~ /(.+)\.rb/
+        r_name = $1;
+        if r_name == "default" 
+          result << key
+        else
+          result << "#{key}::#{r_name}"
+        end
+      end
+    end
+    result
+  end
+  
+  def convert_newline_to_br(string)
+    string.to_s.gsub(/\n/, '<br />') unless string.nil?
+  end
+
+end