OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
openproject/config/initializers/check_mysql_encoding.rb

69 lines
2.7 KiB

#-- encoding: UTF-8
#-- copyright
# OpenProject is a project management system.
# Copyright (C) 2012-2018 the OpenProject Foundation (OPF)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2017 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# See docs/COPYRIGHT.rdoc for more details.
#++
if OpenProject::Database.mysql?
return if ActiveRecord::Type::Boolean.new.cast(ENV['OPENPROJECT_SKIP_MYSQL_ENCODING_CHECK'])
mysql_version = OpenProject::Database.semantic_version
utf8mb4_version = OpenProject::Database.semantic_version '5.7.0'
encoding = ActiveRecord::Base.connection_config[:encoding]
expected = nil
if mysql_version < utf8mb4_version && encoding != "utf8"
expected = "utf8"
elsif mysql_version >= utf8mb4_version && encoding != "utf8mb4"
expected = "utf8mb4"
end
if expected.present?
message = <<-MESSAGE
* * * * * * * * * * * * * * * * * * * * * * * * *
* OpenProject requires UTF-8 encoding set on MySQL < 5.7 *
and UTF-8mb4 beyond that. Please ensure having set
* *
#{Rails.env}:
* encoding: #{expected} *
* in config/database.yml. *
Otherwise, you WILL run into encoding issue when using 4 byte
* UTF-8 characters since utf8 encoding in MySQL doesn't support them. *
* If you have been running utf8 in the past, please see this guide *
on how to convert your database:
* https://mathiasbynens.be/notes/mysql-utf8mb4 *
* * * * * * * * * * * * * * * * * * * * * * * * *
MESSAGE
warn message
end
end