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