cookbooks/mediawiki/resources/site.rb

   1 #
   2 # Cookbook:: mediawiki
   3 # Resource:: mediawiki_site
   4 #
   5 # Copyright:: 2015, OpenStreetMap Foundation
   6 #
   7 # Licensed under the Apache License, Version 2.0 (the "License");
   8 # you may not use this file except in compliance with the License.
   9 # You may obtain a copy of the License at
  10 #
  11 # https://www.apache.org/licenses/LICENSE-2.0
  12 #
  13 # Unless required by applicable law or agreed to in writing, software
  14 # distributed under the License is distributed on an "AS IS" BASIS,
  15 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 # See the License for the specific language governing permissions and
  17 # limitations under the License.
  18 #
  19
  20 unified_mode true
  21
  22 default_action :create
  23
  24 property :site, :kind_of => String, :name_property => true
  25 property :aliases, :kind_of => [String, Array]
  26 property :version, :kind_of => String, :default => "1.39"
  27 property :database_name, :kind_of => String, :required => true
  28 property :database_user, :kind_of => String, :required => [:create, :update]
  29 property :database_password, :kind_of => String, :required => [:create, :update]
  30 property :sitename, :kind_of => String, :default => "OpenStreetMap Wiki"
  31 property :metanamespace, :kind_of => String, :default => "OpenStreetMap"
  32 property :logo, :kind_of => String, :default => "$wgStylePath/common/images/wiki.png"
  33 property :email_contact, :kind_of => String, :default => ""
  34 property :email_sender, :kind_of => String, :default => ""
  35 property :email_sender_name, :kind_of => String, :default => "MediaWiki Mail"
  36 property :commons, :kind_of => [TrueClass, FalseClass], :default => true
  37 property :skin, :kind_of => String, :default => "vector"
  38 property :site_notice, :kind_of => [String, TrueClass, FalseClass], :default => false
  39 property :site_readonly, :kind_of => [String, TrueClass, FalseClass], :default => false
  40 property :admin_user, :kind_of => String, :default => "Admin"
  41 property :admin_password, :kind_of => String, :required => [:create]
  42 property :private_accounts, :kind_of => [TrueClass, FalseClass], :default => false
  43 property :private_site, :kind_of => [TrueClass, FalseClass], :default => false
  44 property :hcaptcha_public_key, :kind_of => String, :default => ""
  45 property :hcaptcha_private_key, :kind_of => String, :default => ""
  46 property :extra_file_extensions, :kind_of => [String, Array], :default => []
  47 property :fpm_max_children, :kind_of => Integer, :default => 5
  48 property :fpm_start_servers, :kind_of => Integer, :default => 2
  49 property :fpm_min_spare_servers, :kind_of => Integer, :default => 1
  50 property :fpm_max_spare_servers, :kind_of => Integer, :default => 3
  51 property :fpm_request_terminate_timeout, :kind_of => Integer, :default => 300
  52 property :fpm_prometheus_port, :kind_of => Integer
  53 property :reload_apache, :kind_of => [TrueClass, FalseClass], :default => true
  54
  55 action :create do
  56   node.default[:mediawiki][:sites][new_resource.site] = {
  57     :directory => site_directory,
  58     :version => new_resource.version
  59   }
  60
  61   mysql_user "#{new_resource.database_user}@localhost" do
  62     password new_resource.database_password
  63     reload true
  64   end
  65
  66   mysql_database new_resource.database_name do
  67     permissions "#{new_resource.database_user}@localhost" => :all
  68   end
  69
  70   mediawiki_directory = "#{site_directory}/w"
  71
  72   declare_resource :directory, site_directory do
  73     owner node[:mediawiki][:user]
  74     group node[:mediawiki][:group]
  75     mode "775"
  76   end
  77
  78   declare_resource :directory, mediawiki_directory do
  79     owner node[:mediawiki][:user]
  80     group node[:mediawiki][:group]
  81     mode "775"
  82   end
  83
  84   git mediawiki_directory do
  85     action :sync
  86     repository "https://gerrit.wikimedia.org/r/mediawiki/core.git"
  87     revision mediawiki_reference
  88     depth 1
  89     user node[:mediawiki][:user]
  90     group node[:mediawiki][:group]
  91   end
  92
  93   template "#{mediawiki_directory}/composer.local.json" do
  94     cookbook "mediawiki"
  95     source "composer.local.json.erb"
  96     owner node[:mediawiki][:user]
  97     group node[:mediawiki][:group]
  98     mode "664"
  99   end
 100
 101   execute "#{mediawiki_directory}/composer.json" do
 102     command "composer update --no-dev"
 103     cwd mediawiki_directory
 104     user node[:mediawiki][:user]
 105     group node[:mediawiki][:group]
 106     environment "COMPOSER_HOME" => site_directory
 107     not_if { ::File.exist?("#{mediawiki_directory}/composer.lock") }
 108   end
 109
 110   execute "#{mediawiki_directory}/maintenance/install.php" do
 111     # Use metanamespace as Site Name to ensure correct set namespace
 112     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}'"
 113     cwd mediawiki_directory
 114     user node[:mediawiki][:user]
 115     group node[:mediawiki][:group]
 116     not_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") }
 117   end
 118
 119   declare_resource :directory, "#{mediawiki_directory}/images" do
 120     owner "www-data"
 121     group node[:mediawiki][:group]
 122     mode "775"
 123   end
 124
 125   declare_resource :directory, "#{mediawiki_directory}/cache" do
 126     owner "www-data"
 127     group node[:mediawiki][:group]
 128     mode "775"
 129   end
 130
 131   declare_resource :directory, "#{mediawiki_directory}/LocalSettings.d" do
 132     user node[:mediawiki][:user]
 133     group node[:mediawiki][:group]
 134     mode "775"
 135   end
 136
 137   template "#{mediawiki_directory}/LocalSettings.php" do
 138     cookbook "mediawiki"
 139     source "LocalSettings.php.erb"
 140     owner node[:mediawiki][:user]
 141     group node[:mediawiki][:group]
 142     mode "664"
 143     variables :name => new_resource.site,
 144               :directory => mediawiki_directory,
 145               :database_params => database_params,
 146               :mediawiki => mediawiki_params,
 147               :secret_key => secret_key
 148   end
 149
 150   service "mediawiki-sitemap@#{new_resource.site}.timer" do
 151     action [:enable, :start]
 152     only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") }
 153   end
 154
 155   service "mediawiki-jobs@#{new_resource.site}.timer" do
 156     action [:enable, :start]
 157     only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") }
 158   end
 159
 160   service "mediawiki-email-jobs@#{new_resource.site}.timer" do
 161     action [:enable, :start]
 162     only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") }
 163   end
 164
 165   template "/etc/cron.daily/mediawiki-#{cron_name}-backup" do
 166     cookbook "mediawiki"
 167     source "mediawiki-backup.cron.erb"
 168     owner "root"
 169     group "root"
 170     mode "700"
 171     variables :name => new_resource.site,
 172               :directory => site_directory,
 173               :database_params => database_params
 174     only_if { ::File.exist?("#{mediawiki_directory}/LocalSettings.php") }
 175   end
 176
 177   # MobileFrontend extension is required by MinervaNeue skin
 178   mediawiki_extension "MobileFrontend" do
 179     site new_resource.site
 180     template "mw-ext-MobileFrontend.inc.php.erb"
 181     update_site false
 182   end
 183
 184   # MobileFrontend extension is required by MinervaNeue skin
 185   mediawiki_skin "MinervaNeue" do
 186     site new_resource.site
 187     update_site false
 188     legacy false
 189   end
 190
 191   mediawiki_skin "CologneBlue" do
 192     site new_resource.site
 193     update_site false
 194     legacy false
 195   end
 196
 197   mediawiki_skin "Modern" do
 198     site new_resource.site
 199     update_site false
 200     legacy false
 201   end
 202
 203   mediawiki_skin "MonoBook" do
 204     site new_resource.site
 205     update_site false
 206     legacy false
 207   end
 208
 209   mediawiki_skin "Vector" do
 210     site new_resource.site
 211     update_site false
 212     legacy false
 213   end
 214
 215   mediawiki_extension "Cite" do
 216     site new_resource.site
 217     update_site false
 218   end
 219
 220   mediawiki_extension "CiteThisPage" do
 221     site new_resource.site
 222     update_site false
 223   end
 224
 225   if new_resource.private_accounts || new_resource.private_site
 226     mediawiki_extension "ConfirmEdit" do
 227       site new_resource.site
 228       update_site false
 229       action :delete
 230     end
 231   else
 232     mediawiki_extension "ConfirmEdit" do
 233       site new_resource.site
 234       template "mw-ext-ConfirmEdit.inc.php.erb"
 235       variables :public_key => new_resource.hcaptcha_public_key,
 236                 :private_key => new_resource.hcaptcha_private_key
 237       update_site false
 238     end
 239   end
 240
 241   mediawiki_extension "Gadgets" do
 242     site new_resource.site
 243     update_site false
 244   end
 245
 246   mediawiki_extension "ImageMap" do
 247     site new_resource.site
 248     update_site false
 249   end
 250
 251   mediawiki_extension "InputBox" do
 252     site new_resource.site
 253     update_site false
 254   end
 255
 256   mediawiki_extension "Interwiki" do
 257     site new_resource.site
 258     template "mw-ext-Interwiki.inc.php.erb"
 259     update_site false
 260   end
 261
 262   mediawiki_extension "Nuke" do
 263     site new_resource.site
 264     update_site false
 265   end
 266
 267   mediawiki_extension "ParserFunctions" do
 268     site new_resource.site
 269     template "mw-ext-ParserFunctions.inc.php.erb"
 270     update_site false
 271   end
 272
 273   mediawiki_extension "PdfHandler" do
 274     site new_resource.site
 275     template "mw-ext-PdfHandler.inc.php.erb"
 276     update_site false
 277   end
 278
 279   mediawiki_extension "Poem" do
 280     site new_resource.site
 281     update_site false
 282   end
 283
 284   mediawiki_extension "Renameuser" do
 285     site new_resource.site
 286     update_site false
 287   end
 288
 289   mediawiki_extension "SimpleAntiSpam" do
 290     site new_resource.site
 291     update_site false
 292     action :delete
 293   end
 294
 295   mediawiki_extension "SpamBlacklist" do
 296     site new_resource.site
 297     template "mw-ext-SpamBlacklist.inc.php.erb"
 298     update_site false
 299   end
 300
 301   mediawiki_extension "SyntaxHighlight_GeSHi" do
 302     site new_resource.site
 303     template "mw-ext-SyntaxHighlight.inc.php.erb"
 304     update_site false
 305   end
 306
 307   mediawiki_extension "TitleBlacklist" do
 308     site new_resource.site
 309     template "mw-ext-TitleBlacklist.inc.php.erb"
 310     update_site false
 311   end
 312
 313   mediawiki_extension "WikiEditor" do
 314     site new_resource.site
 315     update_site false
 316   end
 317
 318   mediawiki_extension "Babel" do
 319     site new_resource.site
 320     template "mw-ext-Babel.inc.php.erb"
 321     update_site false
 322   end
 323
 324   mediawiki_extension "CategoryTree" do
 325     site new_resource.site
 326     update_site false
 327   end
 328
 329   mediawiki_extension "cldr" do
 330     site new_resource.site
 331     template "mw-ext-cldr.inc.php.erb"
 332     update_site false
 333   end
 334
 335   mediawiki_extension "CleanChanges" do
 336     site new_resource.site
 337     template "mw-ext-CleanChanges.inc.php.erb"
 338     update_site false
 339   end
 340
 341   # Extension has been archived: https://www.mediawiki.org/wiki/Extension:LocalisationUpdate
 342   mediawiki_extension "LocalisationUpdate" do
 343     action :delete
 344   end
 345
 346   # mediawiki_extension "Translate" do
 347   #   site new_resource.site
 348   #   template "mw-ext-Translate.inc.php.erb"
 349   #   update_site false
 350   # end
 351
 352   mediawiki_extension "UniversalLanguageSelector" do
 353     site new_resource.site
 354     template "mw-ext-UniversalLanguageSelector.inc.php.erb"
 355     update_site false
 356   end
 357
 358   mediawiki_extension "AntiSpoof" do
 359     site new_resource.site
 360     template "mw-ext-AntiSpoof.inc.php.erb"
 361     update_site false
 362   end
 363
 364   mediawiki_extension "AbuseFilter" do
 365     site new_resource.site
 366     template "mw-ext-AbuseFilter.inc.php.erb"
 367     update_site false
 368   end
 369
 370   mediawiki_extension "CheckUser" do
 371     site new_resource.site
 372     template "mw-ext-CheckUser.inc.php.erb"
 373     update_site false
 374   end
 375
 376   mediawiki_extension "DismissableSiteNotice" do
 377     site new_resource.site
 378     update_site false
 379   end
 380
 381   mediawiki_extension "Elastica" do
 382     site new_resource.site
 383     update_site false
 384   end
 385
 386   mediawiki_extension "CirrusSearch" do
 387     site new_resource.site
 388     template "mw-ext-CirrusSearch.inc.php.erb"
 389     update_site false
 390   end
 391
 392   mediawiki_extension "osmtaginfo" do
 393     site new_resource.site
 394     repository "https://github.com/openstreetmap/osmtaginfo.git"
 395     tag "live"
 396     update_site false
 397   end
 398
 399   mediawiki_extension "OSMCALWikiWidget" do
 400     site new_resource.site
 401     repository "https://github.com/thomersch/OSMCALWikiWidget.git"
 402     tag "live"
 403     update_site false
 404   end
 405
 406   mediawiki_extension "DisableAccount" do
 407     site new_resource.site
 408     template "mw-ext-DisableAccount.inc.php.erb"
 409     update_site false
 410   end
 411
 412   mediawiki_extension "VisualEditor" do
 413     site new_resource.site
 414     template "mw-ext-VisualEditor.inc.php.erb"
 415     variables :version => new_resource.version
 416     update_site false
 417   end
 418
 419   mediawiki_extension "TemplateData" do
 420     site new_resource.site
 421     update_site false
 422   end
 423
 424   if new_resource.commons
 425     mediawiki_extension "QuickInstantCommons" do
 426       site new_resource.site
 427       update_site false
 428     end
 429   else
 430     mediawiki_extension "QuickInstantCommons" do
 431       site new_resource.site
 432       update_site false
 433       action :delete
 434     end
 435   end
 436
 437   cookbook_file "#{site_directory}/cc-wiki.png" do
 438     cookbook "mediawiki"
 439     owner node[:mediawiki][:user]
 440     group node[:mediawiki][:group]
 441     mode "644"
 442     backup false
 443   end
 444
 445   cookbook_file "#{site_directory}/googled06a989d1ccc8364.html" do
 446     cookbook "mediawiki"
 447     owner node[:mediawiki][:user]
 448     group node[:mediawiki][:group]
 449     mode "644"
 450     backup false
 451   end
 452
 453   cookbook_file "#{site_directory}/googlefac54c35e800caab.html" do
 454     cookbook "mediawiki"
 455     owner node[:mediawiki][:user]
 456     group node[:mediawiki][:group]
 457     mode "644"
 458     backup false
 459   end
 460
 461   ssl_certificate new_resource.site do
 462     domains [new_resource.site] + Array(new_resource.aliases)
 463   end
 464
 465   php_fpm new_resource.site do
 466     pm_max_children new_resource.fpm_max_children
 467     pm_start_servers new_resource.fpm_start_servers
 468     pm_min_spare_servers new_resource.fpm_min_spare_servers
 469     pm_max_spare_servers new_resource.fpm_max_spare_servers
 470     request_terminate_timeout new_resource.fpm_request_terminate_timeout
 471     php_admin_values "open_basedir" => "#{site_directory}/:/usr/share/php/:/dev/null:/tmp/"
 472     php_values "memory_limit" => "500M",
 473                "max_execution_time" => "240",
 474                "upload_max_filesize" => "70M",
 475                "post_max_size" => "100M"
 476     prometheus_port new_resource.fpm_prometheus_port
 477   end
 478
 479   apache_site new_resource.site do
 480     cookbook "mediawiki"
 481     template "apache.erb"
 482     directory site_directory
 483     variables :aliases => Array(new_resource.aliases),
 484               :private_site => new_resource.private_site
 485     reload_apache false
 486   end
 487
 488   # FIXME: needs to run one
 489   execute "#{mediawiki_directory}/extensions/CirrusSearch/maintenance/updateSearchIndexConfig.php" do
 490     action :nothing
 491     command "php extensions/CirrusSearch/maintenance/updateSearchIndexConfig.php"
 492     cwd mediawiki_directory
 493     user node[:mediawiki][:user]
 494     group node[:mediawiki][:group]
 495   end
 496 end
 497
 498 action :update do
 499   mediawiki_directory = "#{site_directory}/w"
 500
 501   execute "#{mediawiki_directory}/composer.json" do
 502     command "composer update --no-dev"
 503     cwd mediawiki_directory
 504     user node[:mediawiki][:user]
 505     group node[:mediawiki][:group]
 506     environment "COMPOSER_HOME" => site_directory
 507   end
 508
 509   template "#{mediawiki_directory}/LocalSettings.php" do
 510     cookbook "mediawiki"
 511     source "LocalSettings.php.erb"
 512     owner node[:mediawiki][:user]
 513     group node[:mediawiki][:group]
 514     mode "664"
 515     variables :name => new_resource.site,
 516               :directory => mediawiki_directory,
 517               :database_params => database_params,
 518               :mediawiki => mediawiki_params,
 519               :secret_key => secret_key
 520   end
 521
 522   execute "#{mediawiki_directory}/maintenance/update.php" do
 523     action :run
 524     command "php maintenance/update.php --quick"
 525     cwd mediawiki_directory
 526     user node[:mediawiki][:user]
 527     group node[:mediawiki][:group]
 528     timeout 86400
 529   end
 530 end
 531
 532 action :delete do
 533   apache_site new_resource.site do
 534     action :delete
 535     reload_apache false
 536   end
 537
 538   declare_resource :directory, site_directory do
 539     action :delete
 540     recursive true
 541   end
 542
 543   mysql_database new_resource.database_name do
 544     action :drop
 545   end
 546
 547   mysql_user "#{new_resource.database_user}@localhost" do
 548     action :drop
 549   end
 550 end
 551
 552 action_class do
 553   include OpenStreetMap::Mixin::PersistentToken
 554
 555   def site_directory
 556     "/srv/#{new_resource.site}"
 557   end
 558
 559   def mediawiki_reference
 560     shell_out!("git", "ls-remote", "--refs", "--sort=-version:refname",
 561                "https://gerrit.wikimedia.org/r/mediawiki/core.git",
 562                "refs/tags/#{new_resource.version}.*")
 563       .stdout
 564       .split("\n")
 565       .first
 566       .split("/")
 567       .last
 568   end
 569
 570   def cron_name
 571     new_resource.site.tr(".", "_")
 572   end
 573
 574   def database_params
 575     {
 576       :host => "localhost",
 577       :name => new_resource.database_name,
 578       :username => new_resource.database_user,
 579       :password => new_resource.database_password
 580     }
 581   end
 582
 583   def mediawiki_params
 584     {
 585       :sitename => new_resource.sitename,
 586       :metanamespace => new_resource.metanamespace,
 587       :logo => new_resource.logo,
 588       :email_contact => new_resource.email_contact,
 589       :email_sender => new_resource.email_sender,
 590       :email_sender_name => new_resource.email_sender_name,
 591       :commons => new_resource.commons,
 592       :skin => new_resource.skin,
 593       :site_notice => new_resource.site_notice,
 594       :site_readonly => new_resource.site_readonly,
 595       :extra_file_extensions => new_resource.extra_file_extensions,
 596       :private_accounts => new_resource.private_accounts,
 597       :private_site => new_resource.private_site
 598     }
 599   end
 600
 601   def secret_key
 602     persistent_token("mediawiki", new_resource.site, "wgSecretKey")
 603   end
 604 end
 605
 606 def after_created
 607   notifies :update, "mediawiki_site[#{site}]"
 608   notifies :reload, "service[apache2]" if reload_apache
 609 end