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 :directory, :kind_of => String
  27 property :version, :kind_of => String, :default => "1.37"
  28 property :database_name, :kind_of => String, :required => true
  29 property :database_user, :kind_of => String, :required => [:create, :update]
  30 property :database_password, :kind_of => String, :required => [:create, :update]
  31 property :sitename, :kind_of => String, :default => "OpenStreetMap Wiki"
  32 property :metanamespace, :kind_of => String, :default => "OpenStreetMap"
  33 property :logo, :kind_of => String, :default => "$wgStylePath/common/images/wiki.png"
  34 property :email_contact, :kind_of => String, :default => ""
  35 property :email_sender, :kind_of => String, :default => ""
  36 property :email_sender_name, :kind_of => String, :default => "MediaWiki Mail"
  37 property :commons, :kind_of => [TrueClass, FalseClass], :default => true
  38 property :skin, :kind_of => String, :default => "vector"
  39 property :site_notice, :kind_of => [String, TrueClass, FalseClass], :default => false
  40 property :site_readonly, :kind_of => [String, TrueClass, FalseClass], :default => false
  41 property :admin_user, :kind_of => String, :default => "Admin"
  42 property :admin_password, :kind_of => String, :required => [:create]
  43 property :private_accounts, :kind_of => [TrueClass, FalseClass], :default => false
  44 property :private_site, :kind_of => [TrueClass, FalseClass], :default => false
  45 property :hcaptcha_public_key, :kind_of => String, :default => ""
  46 property :hcaptcha_private_key, :kind_of => String, :default => ""
  47 property :extra_file_extensions, :kind_of => [String, Array], :default => []
  48 property :fpm_max_children, :kind_of => Integer, :default => 5
  49 property :fpm_start_servers, :kind_of => Integer, :default => 2
  50 property :fpm_min_spare_servers, :kind_of => Integer, :default => 1
  51 property :fpm_max_spare_servers, :kind_of => Integer, :default => 3
  52 property :fpm_request_terminate_timeout, :kind_of => Integer, :default => 300
  53 property :fpm_prometheus_port, :kind_of => Integer
  54 property :reload_apache, :kind_of => [TrueClass, FalseClass], :default => true
  55
  56 action :create do
  57   node.default[:mediawiki][:sites][new_resource.site] = {
  58     :directory => site_directory,
  59     :version => new_resource.version
  60   }
  61
  62   secret_key = persistent_token("mediawiki", new_resource.site, "wgSecretKey")
  63
  64   mysql_user "#{new_resource.database_user}@localhost" do
  65     password new_resource.database_password
  66   end
  67
  68   mysql_database new_resource.database_name do
  69     permissions "#{new_resource.database_user}@localhost" => :all
  70   end
  71
  72   mediawiki_directory = "#{site_directory}/w"
  73
  74   ruby_block "rename-installer-localsettings" do
  75     action :nothing
  76     block do
  77       ::File.rename("#{mediawiki_directory}/LocalSettings.php", "#{mediawiki_directory}/LocalSettings-install.php")
  78     end
  79   end
  80
  81   declare_resource :directory, site_directory do
  82     owner node[:mediawiki][:user]
  83     group node[:mediawiki][:group]
  84     mode "775"
  85   end
  86
  87   declare_resource :directory, mediawiki_directory do
  88     owner node[:mediawiki][:user]
  89     group node[:mediawiki][:group]
  90     mode "775"
  91   end
  92
  93   git mediawiki_directory do
  94     action :sync
  95     repository "https://gerrit.wikimedia.org/r/mediawiki/core.git"
  96     revision mediawiki_reference
  97     depth 1
  98     user node[:mediawiki][:user]
  99     group node[:mediawiki][:group]
 100     notifies :run, "execute[#{mediawiki_directory}/composer.json]", :immediately
 101     notifies :run, "execute[#{mediawiki_directory}/maintenance/install.php]", :immediately
 102     notifies :run, "execute[#{mediawiki_directory}/maintenance/update.php]"
 103   end
 104
 105   template "#{mediawiki_directory}/composer.local.json" do
 106     cookbook "mediawiki"
 107     source "composer.local.json.erb"
 108     owner node[:mediawiki][:user]
 109     group node[:mediawiki][:group]
 110     mode "664"
 111   end
 112
 113   execute "#{mediawiki_directory}/composer.json" do
 114     action :nothing
 115     command "composer update --no-dev"
 116     cwd mediawiki_directory
 117     user node[:mediawiki][:user]
 118     group node[:mediawiki][:group]
 119     environment "COMPOSER_HOME" => site_directory
 120   end
 121
 122   execute "#{mediawiki_directory}/maintenance/install.php" do
 123     action :nothing
 124     # Use metanamespace as Site Name to ensure correct set namespace
 125     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}'"
 126     cwd mediawiki_directory
 127     user node[:mediawiki][:user]
 128     group node[:mediawiki][:group]
 129     not_if do
 130       ::File.exist?("#{mediawiki_directory}/LocalSettings-install.php")
 131     end
 132     notifies :run, "ruby_block[rename-installer-localsettings]", :immediately
 133   end
 134
 135   execute "#{mediawiki_directory}/maintenance/update.php" do
 136     action :nothing
 137     command "php maintenance/update.php --quick"
 138     cwd mediawiki_directory
 139     user node[:mediawiki][:user]
 140     group node[:mediawiki][:group]
 141   end
 142
 143   # Safety catch if git doesn't update but install.php hasn't run
 144   ruby_block "catch-installer-localsettings-run" do
 145     action :run
 146     block do
 147     end
 148     not_if do
 149       ::File.exist?("#{mediawiki_directory}/LocalSettings-install.php")
 150     end
 151     notifies :run, "execute[#{mediawiki_directory}/maintenance/install.php]", :immediately
 152   end
 153
 154   declare_resource :directory, "#{mediawiki_directory}/images" do
 155     owner "www-data"
 156     group node[:mediawiki][:group]
 157     mode "775"
 158   end
 159
 160   declare_resource :directory, "#{mediawiki_directory}/cache" do
 161     owner "www-data"
 162     group node[:mediawiki][:group]
 163     mode "775"
 164   end
 165
 166   declare_resource :directory, "#{mediawiki_directory}/LocalSettings.d" do
 167     user node[:mediawiki][:user]
 168     group node[:mediawiki][:group]
 169     mode "775"
 170   end
 171
 172   template "#{mediawiki_directory}/LocalSettings.php" do
 173     cookbook "mediawiki"
 174     source "LocalSettings.php.erb"
 175     owner node[:mediawiki][:user]
 176     group node[:mediawiki][:group]
 177     mode "664"
 178     variables :name => new_resource.site,
 179               :directory => mediawiki_directory,
 180               :database_params => database_params,
 181               :mediawiki => mediawiki_params,
 182               :secret_key => secret_key
 183     notifies :run, "execute[#{mediawiki_directory}/maintenance/update.php]"
 184   end
 185
 186   cron_d "mediawiki-#{cron_name}-sitemap" do
 187     comment "Generate sitemap.xml daily"
 188     minute "30"
 189     hour "0"
 190     user node[:mediawiki][:user]
 191     command "/usr/bin/nice /usr/bin/php -d memory_limit=2048M -d error_reporting=22517 #{site_directory}/w/maintenance/generateSitemap.php --server=https://#{new_resource.site} --urlpath=https://#{new_resource.site}/ --fspath=#{site_directory} --quiet --skip-redirects"
 192   end
 193
 194   cron_d "mediawiki-#{cron_name}-jobs" do
 195     comment "Run mediawiki jobs"
 196     minute "*/3"
 197     user node[:mediawiki][:user]
 198     command "/usr/bin/nice /usr/bin/php -d memory_limit=2048M -d error_reporting=22517 #{site_directory}/w/maintenance/runJobs.php --server=https://#{new_resource.site} --maxtime=160 --memory-limit=2048M --procs=8 --quiet"
 199   end
 200
 201   cron_d "mediawiki-#{cron_name}-email-jobs" do
 202     comment "Run mediawiki email jobs"
 203     user node[:mediawiki][:user]
 204     command "/usr/bin/nice /usr/bin/php -d memory_limit=2048M -d error_reporting=22517 #{site_directory}/w/maintenance/runJobs.php --server=https://#{new_resource.site} --maxtime=30 --type=enotifNotify --memory-limit=2048M --procs=4 --quiet"
 205   end
 206
 207   cron_d "mediawiki-#{cron_name}-refresh-links" do
 208     comment "Run mediawiki refresh links table weekly"
 209     minute "5"
 210     hour "0"
 211     weekday "0"
 212     user node[:mediawiki][:user]
 213     command "/usr/bin/nice /usr/bin/php -d memory_limit=2048M -d error_reporting=22517 #{site_directory}/w/maintenance/refreshLinks.php --server=https://#{new_resource.site} --memory-limit=2048M --quiet"
 214   end
 215
 216   cron_d "mediawiki-#{cron_name}-cleanup-gs" do
 217     comment "Clean up imagemagick garbage"
 218     minute "10"
 219     hour "2"
 220     user node[:mediawiki][:user]
 221     command "/usr/bin/find /tmp/ -maxdepth 1 -type f -user www-data -mmin +90 -name 'gs_*' -delete"
 222   end
 223
 224   cron_d "mediawiki-#{cron_name}-cleanup-magick" do
 225     comment "Clean up imagemagick garbage"
 226     minute "20"
 227     hour "2"
 228     user node[:mediawiki][:user]
 229     command "/usr/bin/find /tmp/ -maxdepth 1 -type f -user www-data -mmin +90 -name 'magick-*' -delete"
 230   end
 231
 232   template "/etc/cron.daily/mediawiki-#{cron_name}-backup" do
 233     cookbook "mediawiki"
 234     source "mediawiki-backup.cron.erb"
 235     owner "root"
 236     group "root"
 237     mode "700"
 238     variables :name => new_resource.site,
 239               :directory => site_directory,
 240               :database_params => database_params
 241   end
 242
 243   # MobileFrontend extension is required by MinervaNeue skin
 244   mediawiki_extension "MobileFrontend" do
 245     site new_resource.site
 246     template "mw-ext-MobileFrontend.inc.php.erb"
 247   end
 248
 249   # MobileFrontend extension is required by MinervaNeue skin
 250   mediawiki_skin "MinervaNeue" do
 251     site new_resource.site
 252     update_site false
 253     legacy false
 254   end
 255
 256   mediawiki_skin "CologneBlue" do
 257     site new_resource.site
 258     update_site false
 259     legacy false
 260   end
 261
 262   mediawiki_skin "Modern" do
 263     site new_resource.site
 264     update_site false
 265     legacy false
 266   end
 267
 268   mediawiki_skin "MonoBook" do
 269     site new_resource.site
 270     update_site false
 271     legacy false
 272   end
 273
 274   mediawiki_skin "Vector" do
 275     site new_resource.site
 276     update_site false
 277     legacy false
 278   end
 279
 280   mediawiki_extension "Cite" do
 281     site new_resource.site
 282     update_site false
 283   end
 284
 285   mediawiki_extension "CiteThisPage" do
 286     site new_resource.site
 287     update_site false
 288   end
 289
 290   if new_resource.private_accounts || new_resource.private_site
 291     mediawiki_extension "ConfirmEdit" do
 292       site new_resource.site
 293       update_site false
 294       action :delete
 295     end
 296   else
 297     mediawiki_extension "ConfirmEdit" do
 298       site new_resource.site
 299       template "mw-ext-ConfirmEdit.inc.php.erb"
 300       variables :public_key => new_resource.hcaptcha_public_key,
 301                 :private_key => new_resource.hcaptcha_private_key
 302       update_site false
 303     end
 304   end
 305
 306   mediawiki_extension "Gadgets" do
 307     site new_resource.site
 308     update_site false
 309   end
 310
 311   mediawiki_extension "ImageMap" do
 312     site new_resource.site
 313     update_site false
 314   end
 315
 316   mediawiki_extension "InputBox" do
 317     site new_resource.site
 318     update_site false
 319   end
 320
 321   mediawiki_extension "Interwiki" do
 322     site new_resource.site
 323     template "mw-ext-Interwiki.inc.php.erb"
 324     update_site false
 325   end
 326
 327   mediawiki_extension "Nuke" do
 328     site new_resource.site
 329     update_site false
 330   end
 331
 332   mediawiki_extension "ParserFunctions" do
 333     site new_resource.site
 334     template "mw-ext-ParserFunctions.inc.php.erb"
 335     update_site false
 336   end
 337
 338   mediawiki_extension "PdfHandler" do
 339     site new_resource.site
 340     template "mw-ext-PdfHandler.inc.php.erb"
 341     update_site false
 342   end
 343
 344   mediawiki_extension "Poem" do
 345     site new_resource.site
 346     update_site false
 347   end
 348
 349   mediawiki_extension "Renameuser" do
 350     site new_resource.site
 351     update_site false
 352   end
 353
 354   mediawiki_extension "SimpleAntiSpam" do
 355     site new_resource.site
 356     update_site false
 357     action :delete
 358   end
 359
 360   mediawiki_extension "SpamBlacklist" do
 361     site new_resource.site
 362     template "mw-ext-SpamBlacklist.inc.php.erb"
 363     update_site false
 364   end
 365
 366   mediawiki_extension "SyntaxHighlight_GeSHi" do
 367     site new_resource.site
 368     template "mw-ext-SyntaxHighlight.inc.php.erb"
 369     update_site false
 370   end
 371
 372   mediawiki_extension "TitleBlacklist" do
 373     site new_resource.site
 374     template "mw-ext-TitleBlacklist.inc.php.erb"
 375     update_site false
 376   end
 377
 378   mediawiki_extension "WikiEditor" do
 379     site new_resource.site
 380     update_site false
 381   end
 382
 383   mediawiki_extension "Babel" do
 384     site new_resource.site
 385     template "mw-ext-Babel.inc.php.erb"
 386     update_site false
 387   end
 388
 389   mediawiki_extension "CategoryTree" do
 390     site new_resource.site
 391     update_site false
 392   end
 393
 394   mediawiki_extension "cldr" do
 395     site new_resource.site
 396     template "mw-ext-cldr.inc.php.erb"
 397     update_site false
 398   end
 399
 400   mediawiki_extension "CleanChanges" do
 401     site new_resource.site
 402     template "mw-ext-CleanChanges.inc.php.erb"
 403     update_site false
 404   end
 405
 406   mediawiki_extension "LocalisationUpdate" do
 407     site new_resource.site
 408     template "mw-ext-LocalisationUpdate.inc.php.erb"
 409     update_site false
 410   end
 411
 412   # mediawiki_extension "Translate" do
 413   #   site new_resource.site
 414   #   template "mw-ext-Translate.inc.php.erb"
 415   #   update_site false
 416   # end
 417
 418   mediawiki_extension "UniversalLanguageSelector" do
 419     site new_resource.site
 420     template "mw-ext-UniversalLanguageSelector.inc.php.erb"
 421     update_site false
 422   end
 423
 424   mediawiki_extension "AntiSpoof" do
 425     site new_resource.site
 426     template "mw-ext-AntiSpoof.inc.php.erb"
 427     update_site false
 428   end
 429
 430   mediawiki_extension "AbuseFilter" do
 431     site new_resource.site
 432     template "mw-ext-AbuseFilter.inc.php.erb"
 433     update_site false
 434   end
 435
 436   mediawiki_extension "CheckUser" do
 437     site new_resource.site
 438     template "mw-ext-CheckUser.inc.php.erb"
 439     update_site false
 440   end
 441
 442   mediawiki_extension "DismissableSiteNotice" do
 443     site new_resource.site
 444     update_site false
 445   end
 446
 447   mediawiki_extension "Elastica" do
 448     site new_resource.site
 449     update_site false
 450   end
 451
 452   mediawiki_extension "CirrusSearch" do
 453     site new_resource.site
 454     template "mw-ext-CirrusSearch.inc.php.erb"
 455     update_site false
 456   end
 457
 458   mediawiki_extension "osmtaginfo" do
 459     site new_resource.site
 460     repository "https://github.com/Firefishy/osmtaginfo.git"
 461     tag "live"
 462     update_site false
 463   end
 464
 465   mediawiki_extension "OSMCALWikiWidget" do
 466     site new_resource.site
 467     repository "https://github.com/thomersch/OSMCALWikiWidget.git"
 468     tag "live"
 469     update_site false
 470   end
 471
 472   mediawiki_extension "SimpleMap" do
 473     site new_resource.site
 474     template "mw-ext-SimpleMap.inc.php.erb"
 475     repository "https://github.com/Firefishy/SimpleMap.git"
 476     tag "live"
 477     update_site false
 478     action :delete
 479   end
 480
 481   mediawiki_extension "SlippyMap" do
 482     site new_resource.site
 483     update_site false
 484     action :delete
 485   end
 486
 487   mediawiki_extension "Mantle" do
 488     site new_resource.site
 489     update_site false
 490     action :delete
 491   end
 492
 493   mediawiki_extension "DisableAccount" do
 494     site new_resource.site
 495     template "mw-ext-DisableAccount.inc.php.erb"
 496     update_site false
 497   end
 498
 499   mediawiki_extension "VisualEditor" do
 500     site new_resource.site
 501     template "mw-ext-VisualEditor.inc.php.erb"
 502     variables :version => new_resource.version
 503     update_site false
 504   end
 505
 506   mediawiki_extension "TemplateData" do
 507     site new_resource.site
 508     update_site false
 509   end
 510
 511   # Broken Extension - 3 April 2022 - Remove. See https://github.com/openstreetmap/chef/pull/491#issuecomment-1086759504
 512   mediawiki_extension "QuickInstantCommons" do
 513     site new_resource.site
 514     update_site false
 515     action :delete
 516   end
 517
 518   cookbook_file "#{site_directory}/cc-wiki.png" do
 519     cookbook "mediawiki"
 520     owner node[:mediawiki][:user]
 521     group node[:mediawiki][:group]
 522     mode "644"
 523     backup false
 524   end
 525
 526   cookbook_file "#{site_directory}/googled06a989d1ccc8364.html" do
 527     cookbook "mediawiki"
 528     owner node[:mediawiki][:user]
 529     group node[:mediawiki][:group]
 530     mode "644"
 531     backup false
 532   end
 533
 534   cookbook_file "#{site_directory}/googlefac54c35e800caab.html" do
 535     cookbook "mediawiki"
 536     owner node[:mediawiki][:user]
 537     group node[:mediawiki][:group]
 538     mode "644"
 539     backup false
 540   end
 541
 542   ssl_certificate new_resource.site do
 543     domains [new_resource.site] + Array(new_resource.aliases)
 544   end
 545
 546   php_fpm new_resource.site do
 547     pm_max_children new_resource.fpm_max_children
 548     pm_start_servers new_resource.fpm_start_servers
 549     pm_min_spare_servers new_resource.fpm_min_spare_servers
 550     pm_max_spare_servers new_resource.fpm_max_spare_servers
 551     request_terminate_timeout new_resource.fpm_request_terminate_timeout
 552     php_admin_values "open_basedir" => "#{site_directory}/:/usr/share/php/:/dev/null:/tmp/"
 553     php_values "memory_limit" => "500M",
 554                "max_execution_time" => "240",
 555                "upload_max_filesize" => "70M",
 556                "post_max_size" => "100M"
 557     prometheus_port new_resource.fpm_prometheus_port
 558   end
 559
 560   apache_site new_resource.site do
 561     cookbook "mediawiki"
 562     template "apache.erb"
 563     directory site_directory
 564     variables :aliases => Array(new_resource.aliases),
 565               :private_site => new_resource.private_site
 566     reload_apache false
 567   end
 568
 569   # FIXME: needs to run one
 570   execute "#{mediawiki_directory}/extensions/CirrusSearch/maintenance/updateSearchIndexConfig.php" do
 571     action :nothing
 572     command "php extensions/CirrusSearch/maintenance/updateSearchIndexConfig.php"
 573     cwd mediawiki_directory
 574     user node[:mediawiki][:user]
 575     group node[:mediawiki][:group]
 576   end
 577 end
 578
 579 action :update do
 580   mediawiki_directory = "#{site_directory}/w"
 581
 582   template "#{mediawiki_directory}/LocalSettings.php" do
 583     cookbook "mediawiki"
 584     source "LocalSettings.php.erb"
 585     owner node[:mediawiki][:user]
 586     group node[:mediawiki][:group]
 587     mode "664"
 588     variables :name => new_resource.site,
 589               :directory => mediawiki_directory,
 590               :database_params => database_params,
 591               :mediawiki => mediawiki_params
 592     notifies :run, "execute[#{mediawiki_directory}/maintenance/update.php]"
 593   end
 594
 595   execute "#{mediawiki_directory}/maintenance/update.php" do
 596     action :run
 597     command "php maintenance/update.php --quick"
 598     cwd mediawiki_directory
 599     user node[:mediawiki][:user]
 600     group node[:mediawiki][:group]
 601   end
 602 end
 603
 604 action :delete do
 605   apache_site new_resource.site do
 606     action :delete
 607     reload_apache false
 608   end
 609
 610   declare_resource :directory, site_directory do
 611     action :delete
 612     recursive true
 613   end
 614
 615   mysql_database new_resource.database_name do
 616     action :drop
 617   end
 618
 619   mysql_user "#{new_resource.database_user}@localhost" do
 620     action :drop
 621   end
 622 end
 623
 624 action_class do
 625   include Chef::Mixin::PersistentToken
 626
 627   def site_directory
 628     new_resource.directory || "/srv/#{new_resource.site}"
 629   end
 630
 631   def mediawiki_reference
 632     shell_out!("git", "ls-remote", "--refs", "--sort=-version:refname",
 633                "https://gerrit.wikimedia.org/r/mediawiki/core.git",
 634                "refs/tags/#{new_resource.version}.*")
 635       .stdout
 636       .split("\n")
 637       .first
 638       .split("/")
 639       .last
 640   end
 641
 642   def cron_name
 643     new_resource.site.tr(".", "_")
 644   end
 645
 646   def database_params
 647     {
 648       :host => "localhost",
 649       :name => new_resource.database_name,
 650       :username => new_resource.database_user,
 651       :password => new_resource.database_password
 652     }
 653   end
 654
 655   def mediawiki_params
 656     {
 657       :sitename => new_resource.sitename,
 658       :metanamespace => new_resource.metanamespace,
 659       :logo => new_resource.logo,
 660       :email_contact => new_resource.email_contact,
 661       :email_sender => new_resource.email_sender,
 662       :email_sender_name => new_resource.email_sender_name,
 663       :commons => new_resource.commons,
 664       :skin => new_resource.skin,
 665       :site_notice => new_resource.site_notice,
 666       :site_readonly => new_resource.site_readonly,
 667       :extra_file_extensions => new_resource.extra_file_extensions,
 668       :private_accounts => new_resource.private_accounts,
 669       :private_site => new_resource.private_site
 670     }
 671   end
 672 end
 673
 674 def after_created
 675   notifies :reload, "service[apache2]" if reload_apache
 676 end