X-Git-Url: https://git.openstreetmap.org./chef.git/blobdiff_plain/0b38187153c7cd47c6690c9741580751b4af24a1..0a6889527f95e185d70a5f3a8fc916114b1a109c:/cookbooks/mediawiki/resources/site.rb diff --git a/cookbooks/mediawiki/resources/site.rb b/cookbooks/mediawiki/resources/site.rb index 57f30549b..476ce1699 100644 --- a/cookbooks/mediawiki/resources/site.rb +++ b/cookbooks/mediawiki/resources/site.rb @@ -1,8 +1,8 @@ # -# Cookbook Name:: mediawiki +# Cookbook:: mediawiki # Resource:: mediawiki_site # -# Copyright 2015, OpenStreetMap Foundation +# Copyright:: 2015, OpenStreetMap Foundation # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -17,15 +17,17 @@ # limitations under the License. # +unified_mode true + default_action :create -property :site, :kind_of => String, :name_attribute => true +property :site, :kind_of => String, :name_property => true property :aliases, :kind_of => [String, Array] property :directory, :kind_of => String -property :version, :kind_of => String, :default => "1.31" +property :version, :kind_of => String, :default => "1.39" property :database_name, :kind_of => String, :required => true -property :database_user, :kind_of => String, :required => true -property :database_password, :kind_of => String, :required => true +property :database_user, :kind_of => String, :required => [:create, :update] +property :database_password, :kind_of => String, :required => [:create, :update] property :sitename, :kind_of => String, :default => "OpenStreetMap Wiki" property :metanamespace, :kind_of => String, :default => "OpenStreetMap" property :logo, :kind_of => String, :default => "$wgStylePath/common/images/wiki.png" @@ -37,24 +39,29 @@ property :skin, :kind_of => String, :default => "vector" property :site_notice, :kind_of => [String, TrueClass, FalseClass], :default => false property :site_readonly, :kind_of => [String, TrueClass, FalseClass], :default => false property :admin_user, :kind_of => String, :default => "Admin" -property :admin_password, :kind_of => String, :required => true +property :admin_password, :kind_of => String, :required => [:create] property :private_accounts, :kind_of => [TrueClass, FalseClass], :default => false property :private_site, :kind_of => [TrueClass, FalseClass], :default => false -property :recaptcha_public_key, :kind_of => String -property :recaptcha_private_key, :kind_of => String +property :hcaptcha_public_key, :kind_of => String, :default => "" +property :hcaptcha_private_key, :kind_of => String, :default => "" property :extra_file_extensions, :kind_of => [String, Array], :default => [] +property :fpm_max_children, :kind_of => Integer, :default => 5 +property :fpm_start_servers, :kind_of => Integer, :default => 2 +property :fpm_min_spare_servers, :kind_of => Integer, :default => 1 +property :fpm_max_spare_servers, :kind_of => Integer, :default => 3 +property :fpm_request_terminate_timeout, :kind_of => Integer, :default => 300 +property :fpm_prometheus_port, :kind_of => Integer property :reload_apache, :kind_of => [TrueClass, FalseClass], :default => true action :create do - node.normal_unless[:mediawiki][:sites][new_resource.site] = {} - - node.normal[:mediawiki][:sites][new_resource.site][:directory] = site_directory - node.normal[:mediawiki][:sites][new_resource.site][:version] = new_resource.version - - node.normal_unless[:mediawiki][:sites][new_resource.site][:wgSecretKey] = SecureRandom.base64(48) + node.default[:mediawiki][:sites][new_resource.site] = { + :directory => site_directory, + :version => new_resource.version + } mysql_user "#{new_resource.database_user}@localhost" do password new_resource.database_password + reload true end mysql_database new_resource.database_name do @@ -63,94 +70,69 @@ action :create do mediawiki_directory = "#{site_directory}/w" - ruby_block "rename-installer-localsettings" do - action :nothing - block do - ::File.rename("#{mediawiki_directory}/LocalSettings.php", "#{mediawiki_directory}/LocalSettings-install.php") - end - end - - execute "#{mediawiki_directory}/maintenance/install.php" do - action :nothing - # Use metanamespace as Site Name to ensure correct set namespace - command "php maintenance/install.php --server '#{name}' --dbtype 'mysql' --dbname '#{new_resource.database_name}' --dbuser '#{new_resource.database_user}' --dbpass '#{new_resource.database_password}' --dbserver 'localhost' --scriptpath /w --pass '#{new_resource.admin_password}' '#{new_resource.metanamespace}' '#{new_resource.admin_user}'" - cwd mediawiki_directory - user node[:mediawiki][:user] - group node[:mediawiki][:group] - not_if do - ::File.exist?("#{mediawiki_directory}/LocalSettings-install.php") - end - notifies :run, "ruby_block[rename-installer-localsettings]", :immediately - end - - execute "#{mediawiki_directory}/maintenance/update.php" do - action :nothing - command "php maintenance/update.php --quick" - cwd mediawiki_directory - user node[:mediawiki][:user] - group node[:mediawiki][:group] - end - declare_resource :directory, site_directory do owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o775 + mode "775" end declare_resource :directory, mediawiki_directory do owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o775 + mode "775" end - mediawiki_reference = "REL#{new_resource.version}".tr(".", "_") - - git "#{mediawiki_directory}/vendor" do - action :nothing - repository "https://gerrit.wikimedia.org/r/p/mediawiki/vendor.git" + git mediawiki_directory do + action :sync + repository "https://gerrit.wikimedia.org/r/mediawiki/core.git" revision mediawiki_reference + depth 1 user node[:mediawiki][:user] group node[:mediawiki][:group] end - git mediawiki_directory do - action :sync - repository "https://gerrit.wikimedia.org/r/p/mediawiki/core.git" - revision mediawiki_reference + template "#{mediawiki_directory}/composer.local.json" do + cookbook "mediawiki" + source "composer.local.json.erb" + owner node[:mediawiki][:user] + group node[:mediawiki][:group] + mode "664" + end + + execute "#{mediawiki_directory}/composer.json" do + command "composer update --no-dev" + cwd mediawiki_directory user node[:mediawiki][:user] group node[:mediawiki][:group] - notifies :sync, "git[#{mediawiki_directory}/vendor]", :immediately - notifies :run, "execute[#{mediawiki_directory}/maintenance/install.php]", :immediately - notifies :run, "execute[#{mediawiki_directory}/maintenance/update.php]" + environment "COMPOSER_HOME" => site_directory + not_if { ::File.exist?("#{mediawiki_directory}/composer.lock") } end - # Safety catch if git doesn't update but install.php hasn't run - ruby_block "catch-installer-localsettings-run" do - action :run - block do - end - not_if do - ::File.exist?("#{mediawiki_directory}/LocalSettings-install.php") - end - notifies :run, "execute[#{mediawiki_directory}/maintenance/install.php]", :immediately + execute "#{mediawiki_directory}/maintenance/install.php" do + # Use metanamespace as Site Name to ensure correct set namespace + command "php maintenance/install.php --server '#{name}' --dbtype 'mysql' --dbname '#{new_resource.database_name}' --dbuser '#{new_resource.database_user}' --dbpass '#{new_resource.database_password}' --dbserver 'localhost' --scriptpath /w --pass '#{new_resource.admin_password}' '#{new_resource.metanamespace}' '#{new_resource.admin_user}'" + cwd mediawiki_directory + user node[:mediawiki][:user] + group node[:mediawiki][:group] + not_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") } end declare_resource :directory, "#{mediawiki_directory}/images" do owner "www-data" group node[:mediawiki][:group] - mode 0o775 + mode "775" end declare_resource :directory, "#{mediawiki_directory}/cache" do owner "www-data" group node[:mediawiki][:group] - mode 0o775 + mode "775" end declare_resource :directory, "#{mediawiki_directory}/LocalSettings.d" do user node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o775 + mode "775" end template "#{mediawiki_directory}/LocalSettings.php" do @@ -158,22 +140,32 @@ action :create do source "LocalSettings.php.erb" owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o664 + mode "664" variables :name => new_resource.site, :directory => mediawiki_directory, :database_params => database_params, - :mediawiki => mediawiki_params - notifies :run, "execute[#{mediawiki_directory}/maintenance/update.php]" + :mediawiki => mediawiki_params, + :secret_key => secret_key end - template "/etc/cron.d/mediawiki-#{cron_name}" do - cookbook "mediawiki" - source "mediawiki.cron.erb" - owner "root" - group "root" - mode 0o644 - variables :name => new_resource.site, :directory => site_directory, - :user => node[:mediawiki][:user] + service "mediawiki-sitemap@#{new_resource.site}.timer" do + action [:enable, :start] + only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") } + end + + service "mediawiki-jobs@#{new_resource.site}.timer" do + action [:enable, :start] + only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") } + end + + service "mediawiki-email-jobs@#{new_resource.site}.timer" do + action [:enable, :start] + only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") } + end + + service "mediawiki-refresh-links@#{new_resource.site}.timer" do + action [:enable, :start] + only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") } end template "/etc/cron.daily/mediawiki-#{cron_name}-backup" do @@ -181,35 +173,49 @@ action :create do source "mediawiki-backup.cron.erb" owner "root" group "root" - mode 0o700 + mode "700" variables :name => new_resource.site, :directory => site_directory, :database_params => database_params + only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") } end - mediawiki_skin "MinervaNeue" do # ~FC005 + # MobileFrontend extension is required by MinervaNeue skin + mediawiki_extension "MobileFrontend" do site new_resource.site + template "mw-ext-MobileFrontend.inc.php.erb" update_site false end - mediawiki_skin "CologneBlue" do # ~FC005 + # MobileFrontend extension is required by MinervaNeue skin + mediawiki_skin "MinervaNeue" do site new_resource.site update_site false + legacy false + end + + mediawiki_skin "CologneBlue" do + site new_resource.site + update_site false + legacy false end mediawiki_skin "Modern" do site new_resource.site update_site false + legacy false end mediawiki_skin "MonoBook" do site new_resource.site update_site false + legacy false end mediawiki_skin "Vector" do site new_resource.site update_site false + legacy false end mediawiki_extension "Cite" do @@ -232,8 +238,8 @@ action :create do mediawiki_extension "ConfirmEdit" do site new_resource.site template "mw-ext-ConfirmEdit.inc.php.erb" - variables :public_key => new_resource.recaptcha_public_key, - :private_key => new_resource.recaptcha_private_key + variables :public_key => new_resource.hcaptcha_public_key, + :private_key => new_resource.hcaptcha_private_key update_site false end end @@ -255,6 +261,7 @@ action :create do mediawiki_extension "Interwiki" do site new_resource.site + template "mw-ext-Interwiki.inc.php.erb" update_site false end @@ -320,6 +327,11 @@ action :create do update_site false end + mediawiki_extension "CategoryTree" do + site new_resource.site + update_site false + end + mediawiki_extension "cldr" do site new_resource.site template "mw-ext-cldr.inc.php.erb" @@ -338,16 +350,6 @@ action :create do update_site false end - # LocalisationUpdate Update Cron - # template "/etc/cron.d/mediawiki-#{name}-LocalisationUpdate" do - # cookbook "mediawiki" - # source "mediawiki-LocalisationUpdate.cron.erb" - # owner "root" - # group "root" - # mode 0755 - # variables :name => name, :directory => site_directory, :user => node[:mediawiki][:user] - # end - # mediawiki_extension "Translate" do # site new_resource.site # template "mw-ext-Translate.inc.php.erb" @@ -363,14 +365,12 @@ action :create do mediawiki_extension "AntiSpoof" do site new_resource.site template "mw-ext-AntiSpoof.inc.php.erb" - compose true update_site false end mediawiki_extension "AbuseFilter" do site new_resource.site template "mw-ext-AbuseFilter.inc.php.erb" - compose true update_site false end @@ -387,47 +387,29 @@ action :create do mediawiki_extension "Elastica" do site new_resource.site - compose true update_site false end mediawiki_extension "CirrusSearch" do site new_resource.site - compose true template "mw-ext-CirrusSearch.inc.php.erb" update_site false end mediawiki_extension "osmtaginfo" do site new_resource.site - template "mw-ext-osmtaginfo.inc.php.erb" - repository "git://github.com/Firefishy/osmtaginfo.git" - tag "live" - update_site false - end - - mediawiki_extension "SimpleMap" do - site new_resource.site - template "mw-ext-SimpleMap.inc.php.erb" - repository "git://github.com/Firefishy/SimpleMap.git" + repository "https://github.com/openstreetmap/osmtaginfo.git" tag "live" update_site false end - mediawiki_extension "SlippyMap" do + mediawiki_extension "OSMCALWikiWidget" do site new_resource.site - template "mw-ext-SlippyMap.inc.php.erb" - repository "git://github.com/Firefishy/SlippyMap.git" + repository "https://github.com/thomersch/OSMCALWikiWidget.git" tag "live" update_site false end - mediawiki_extension "Mantle" do - site new_resource.site - update_site false - action :delete - end - mediawiki_extension "DisableAccount" do site new_resource.site template "mw-ext-DisableAccount.inc.php.erb" @@ -437,6 +419,7 @@ action :create do mediawiki_extension "VisualEditor" do site new_resource.site template "mw-ext-VisualEditor.inc.php.erb" + variables :version => new_resource.version update_site false end @@ -445,11 +428,24 @@ action :create do update_site false end + if new_resource.commons + mediawiki_extension "QuickInstantCommons" do + site new_resource.site + update_site false + end + else + mediawiki_extension "QuickInstantCommons" do + site new_resource.site + update_site false + action :delete + end + end + cookbook_file "#{site_directory}/cc-wiki.png" do cookbook "mediawiki" owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o644 + mode "644" backup false end @@ -457,7 +453,7 @@ action :create do cookbook "mediawiki" owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o644 + mode "644" backup false end @@ -465,7 +461,7 @@ action :create do cookbook "mediawiki" owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o644 + mode "644" backup false end @@ -473,6 +469,20 @@ action :create do domains [new_resource.site] + Array(new_resource.aliases) end + php_fpm new_resource.site do + pm_max_children new_resource.fpm_max_children + pm_start_servers new_resource.fpm_start_servers + pm_min_spare_servers new_resource.fpm_min_spare_servers + pm_max_spare_servers new_resource.fpm_max_spare_servers + request_terminate_timeout new_resource.fpm_request_terminate_timeout + php_admin_values "open_basedir" => "#{site_directory}/:/usr/share/php/:/dev/null:/tmp/" + php_values "memory_limit" => "500M", + "max_execution_time" => "240", + "upload_max_filesize" => "70M", + "post_max_size" => "100M" + prometheus_port new_resource.fpm_prometheus_port + end + apache_site new_resource.site do cookbook "mediawiki" template "apache.erb" @@ -495,17 +505,25 @@ end action :update do mediawiki_directory = "#{site_directory}/w" + execute "#{mediawiki_directory}/composer.json" do + command "composer update --no-dev" + cwd mediawiki_directory + user node[:mediawiki][:user] + group node[:mediawiki][:group] + environment "COMPOSER_HOME" => site_directory + end + template "#{mediawiki_directory}/LocalSettings.php" do cookbook "mediawiki" source "LocalSettings.php.erb" owner node[:mediawiki][:user] group node[:mediawiki][:group] - mode 0o664 + mode "664" variables :name => new_resource.site, :directory => mediawiki_directory, :database_params => database_params, - :mediawiki => mediawiki_params - notifies :run, "execute[#{mediawiki_directory}/maintenance/update.php]" + :mediawiki => mediawiki_params, + :secret_key => secret_key end execute "#{mediawiki_directory}/maintenance/update.php" do @@ -514,6 +532,7 @@ action :update do cwd mediawiki_directory user node[:mediawiki][:user] group node[:mediawiki][:group] + timeout 86400 end end @@ -538,10 +557,23 @@ action :delete do end action_class do + include OpenStreetMap::Mixin::PersistentToken + def site_directory new_resource.directory || "/srv/#{new_resource.site}" end + def mediawiki_reference + shell_out!("git", "ls-remote", "--refs", "--sort=-version:refname", + "https://gerrit.wikimedia.org/r/mediawiki/core.git", + "refs/tags/#{new_resource.version}.*") + .stdout + .split("\n") + .first + .split("/") + .last + end + def cron_name new_resource.site.tr(".", "_") end @@ -572,8 +604,13 @@ action_class do :private_site => new_resource.private_site } end + + def secret_key + persistent_token("mediawiki", new_resource.site, "wgSecretKey") + end end def after_created + notifies :update, "mediawiki_site[#{site}]" notifies :reload, "service[apache2]" if reload_apache end