cookbooks/mediawiki/resources/site.rb

   1 #
   2 # Cookbook Name:: 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_attribute => true
  23 property :aliases, :kind_of => [String, Array]
  24 property :directory, :kind_of => String
  25 property :version, :kind_of => String, :default => "1.31"
  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}/vendor" do
 109     action :nothing
 110     repository "https://gerrit.wikimedia.org/r/p/mediawiki/vendor.git"
 111     revision mediawiki_reference
 112     user node[:mediawiki][:user]
 113     group node[:mediawiki][:group]
 114   end
 115
 116   git mediawiki_directory do
 117     action :sync
 118     repository "https://gerrit.wikimedia.org/r/p/mediawiki/core.git"
 119     revision mediawiki_reference
 120     user node[:mediawiki][:user]
 121     group node[:mediawiki][:group]
 122     notifies :sync, "git[#{mediawiki_directory}/vendor]", :immediately
 123     notifies :run, "execute[#{mediawiki_directory}/maintenance/install.php]", :immediately
 124     notifies :run, "execute[#{mediawiki_directory}/maintenance/update.php]"
 125   end
 126
 127   # Safety catch if git doesn't update but install.php hasn't run
 128   ruby_block "catch-installer-localsettings-run" do
 129     action :run
 130     block do
 131     end
 132     not_if do
 133       ::File.exist?("#{mediawiki_directory}/LocalSettings-install.php")
 134     end
 135     notifies :run, "execute[#{mediawiki_directory}/maintenance/install.php]", :immediately
 136   end
 137
 138   declare_resource :directory, "#{mediawiki_directory}/images" do
 139     owner "www-data"
 140     group node[:mediawiki][:group]
 141     mode 0o775
 142   end
 143
 144   declare_resource :directory, "#{mediawiki_directory}/cache" do
 145     owner "www-data"
 146     group node[:mediawiki][:group]
 147     mode 0o775
 148   end
 149
 150   declare_resource :directory, "#{mediawiki_directory}/LocalSettings.d" do
 151     user node[:mediawiki][:user]
 152     group node[:mediawiki][:group]
 153     mode 0o775
 154   end
 155
 156   template "#{mediawiki_directory}/LocalSettings.php" do
 157     cookbook "mediawiki"
 158     source "LocalSettings.php.erb"
 159     owner node[:mediawiki][:user]
 160     group node[:mediawiki][:group]
 161     mode 0o664
 162     variables :name => new_resource.site,
 163               :directory => mediawiki_directory,
 164               :database_params => database_params,
 165               :mediawiki => mediawiki_params
 166     notifies :run, "execute[#{mediawiki_directory}/maintenance/update.php]"
 167   end
 168
 169   template "/etc/cron.d/mediawiki-#{cron_name}" do
 170     cookbook "mediawiki"
 171     source "mediawiki.cron.erb"
 172     owner "root"
 173     group "root"
 174     mode 0o644
 175     variables :name => new_resource.site, :directory => site_directory,
 176               :user => node[:mediawiki][:user]
 177   end
 178
 179   template "/etc/cron.daily/mediawiki-#{cron_name}-backup" do
 180     cookbook "mediawiki"
 181     source "mediawiki-backup.cron.erb"
 182     owner "root"
 183     group "root"
 184     mode 0o700
 185     variables :name => new_resource.site,
 186               :directory => site_directory,
 187               :database_params => database_params
 188   end
 189
 190   # MobileFrontend extension is required by MinervaNeue skin
 191   mediawiki_extension "MobileFrontend" do # ~FC005
 192     site new_resource.site
 193     template "mw-ext-MobileFrontend.inc.php.erb"
 194   end
 195
 196   # MobileFrontend extension is required by MinervaNeue skin
 197   mediawiki_skin "MinervaNeue" do # ~FC005
 198     site new_resource.site
 199     update_site false
 200     legacy false
 201   end
 202
 203   mediawiki_skin "CologneBlue" do
 204     site new_resource.site
 205     update_site false
 206     legacy false
 207   end
 208
 209   mediawiki_skin "Modern" do
 210     site new_resource.site
 211     update_site false
 212     legacy false
 213   end
 214
 215   mediawiki_skin "MonoBook" do
 216     site new_resource.site
 217     update_site false
 218     legacy false
 219   end
 220
 221   mediawiki_skin "Vector" do
 222     site new_resource.site
 223     update_site false
 224     legacy false
 225   end
 226
 227   mediawiki_extension "Cite" do
 228     site new_resource.site
 229     update_site false
 230   end
 231
 232   mediawiki_extension "CiteThisPage" do
 233     site new_resource.site
 234     update_site false
 235   end
 236
 237   if new_resource.private_accounts || new_resource.private_site
 238     mediawiki_extension "ConfirmEdit" do
 239       site new_resource.site
 240       update_site false
 241       action :delete
 242     end
 243   else
 244     mediawiki_extension "ConfirmEdit" do
 245       site new_resource.site
 246       template "mw-ext-ConfirmEdit.inc.php.erb"
 247       variables :public_key => new_resource.recaptcha_public_key,
 248                 :private_key => new_resource.recaptcha_private_key
 249       update_site false
 250     end
 251   end
 252
 253   mediawiki_extension "Gadgets" do
 254     site new_resource.site
 255     update_site false
 256   end
 257
 258   mediawiki_extension "ImageMap" do
 259     site new_resource.site
 260     update_site false
 261   end
 262
 263   mediawiki_extension "InputBox" do
 264     site new_resource.site
 265     update_site false
 266   end
 267
 268   mediawiki_extension "Interwiki" do
 269     site new_resource.site
 270     template "mw-ext-Interwiki.inc.php.erb"
 271     update_site false
 272   end
 273
 274   mediawiki_extension "Nuke" do
 275     site new_resource.site
 276     update_site false
 277   end
 278
 279   mediawiki_extension "ParserFunctions" do
 280     site new_resource.site
 281     template "mw-ext-ParserFunctions.inc.php.erb"
 282     update_site false
 283   end
 284
 285   mediawiki_extension "PdfHandler" do
 286     site new_resource.site
 287     template "mw-ext-PdfHandler.inc.php.erb"
 288     update_site false
 289   end
 290
 291   mediawiki_extension "Poem" do
 292     site new_resource.site
 293     update_site false
 294   end
 295
 296   mediawiki_extension "Renameuser" do
 297     site new_resource.site
 298     update_site false
 299   end
 300
 301   mediawiki_extension "SimpleAntiSpam" do
 302     site new_resource.site
 303     update_site false
 304     action :delete
 305   end
 306
 307   mediawiki_extension "SpamBlacklist" do
 308     site new_resource.site
 309     template "mw-ext-SpamBlacklist.inc.php.erb"
 310     update_site false
 311   end
 312
 313   mediawiki_extension "SyntaxHighlight_GeSHi" do
 314     site new_resource.site
 315     template "mw-ext-SyntaxHighlight.inc.php.erb"
 316     update_site false
 317   end
 318
 319   mediawiki_extension "TitleBlacklist" do
 320     site new_resource.site
 321     template "mw-ext-TitleBlacklist.inc.php.erb"
 322     update_site false
 323   end
 324
 325   mediawiki_extension "WikiEditor" do
 326     site new_resource.site
 327     update_site false
 328   end
 329
 330   mediawiki_extension "Babel" do
 331     site new_resource.site
 332     template "mw-ext-Babel.inc.php.erb"
 333     update_site false
 334   end
 335
 336   mediawiki_extension "cldr" do
 337     site new_resource.site
 338     template "mw-ext-cldr.inc.php.erb"
 339     update_site false
 340   end
 341
 342   mediawiki_extension "CleanChanges" do
 343     site new_resource.site
 344     template "mw-ext-CleanChanges.inc.php.erb"
 345     update_site false
 346   end
 347
 348   mediawiki_extension "LocalisationUpdate" do
 349     site new_resource.site
 350     template "mw-ext-LocalisationUpdate.inc.php.erb"
 351     update_site false
 352   end
 353
 354   # LocalisationUpdate Update Cron
 355   # template "/etc/cron.d/mediawiki-#{name}-LocalisationUpdate" do
 356   #   cookbook "mediawiki"
 357   #   source "mediawiki-LocalisationUpdate.cron.erb"
 358   #   owner "root"
 359   #   group "root"
 360   #   mode 0755
 361   #   variables :name => name, :directory => site_directory, :user => node[:mediawiki][:user]
 362   # end
 363
 364   # mediawiki_extension "Translate" do
 365   #   site new_resource.site
 366   #   template "mw-ext-Translate.inc.php.erb"
 367   #   update_site false
 368   # end
 369
 370   mediawiki_extension "UniversalLanguageSelector" do
 371     site new_resource.site
 372     template "mw-ext-UniversalLanguageSelector.inc.php.erb"
 373     update_site false
 374   end
 375
 376   mediawiki_extension "AntiSpoof" do
 377     site new_resource.site
 378     template "mw-ext-AntiSpoof.inc.php.erb"
 379     compose true
 380     update_site false
 381   end
 382
 383   mediawiki_extension "AbuseFilter" do
 384     site new_resource.site
 385     template "mw-ext-AbuseFilter.inc.php.erb"
 386     compose true
 387     update_site false
 388   end
 389
 390   mediawiki_extension "CheckUser" do
 391     site new_resource.site
 392     template "mw-ext-CheckUser.inc.php.erb"
 393     update_site false
 394   end
 395
 396   mediawiki_extension "DismissableSiteNotice" do
 397     site new_resource.site
 398     update_site false
 399   end
 400
 401   mediawiki_extension "Elastica" do
 402     site new_resource.site
 403     compose true
 404     update_site false
 405   end
 406
 407   mediawiki_extension "CirrusSearch" do
 408     site new_resource.site
 409     compose true
 410     template "mw-ext-CirrusSearch.inc.php.erb"
 411     update_site false
 412   end
 413
 414   mediawiki_extension "osmtaginfo" do
 415     site new_resource.site
 416     template "mw-ext-osmtaginfo.inc.php.erb"
 417     repository "git://github.com/Firefishy/osmtaginfo.git"
 418     tag "live"
 419     update_site false
 420   end
 421
 422   mediawiki_extension "SimpleMap" do
 423     site new_resource.site
 424     template "mw-ext-SimpleMap.inc.php.erb"
 425     repository "git://github.com/Firefishy/SimpleMap.git"
 426     tag "live"
 427     update_site false
 428   end
 429
 430   mediawiki_extension "SlippyMap" do
 431     site new_resource.site
 432     template "mw-ext-SlippyMap.inc.php.erb"
 433     repository "git://github.com/Firefishy/SlippyMap.git"
 434     tag "live"
 435     update_site false
 436   end
 437
 438   mediawiki_extension "Mantle" do
 439     site new_resource.site
 440     update_site false
 441     action :delete
 442   end
 443
 444   mediawiki_extension "DisableAccount" do
 445     site new_resource.site
 446     template "mw-ext-DisableAccount.inc.php.erb"
 447     update_site false
 448   end
 449
 450   mediawiki_extension "VisualEditor" do
 451     site new_resource.site
 452     template "mw-ext-VisualEditor.inc.php.erb"
 453     update_site false
 454   end
 455
 456   mediawiki_extension "TemplateData" do
 457     site new_resource.site
 458     update_site false
 459   end
 460
 461   cookbook_file "#{site_directory}/cc-wiki.png" do
 462     cookbook "mediawiki"
 463     owner node[:mediawiki][:user]
 464     group node[:mediawiki][:group]
 465     mode 0o644
 466     backup false
 467   end
 468
 469   cookbook_file "#{site_directory}/googled06a989d1ccc8364.html" do
 470     cookbook "mediawiki"
 471     owner node[:mediawiki][:user]
 472     group node[:mediawiki][:group]
 473     mode 0o644
 474     backup false
 475   end
 476
 477   cookbook_file "#{site_directory}/googlefac54c35e800caab.html" do
 478     cookbook "mediawiki"
 479     owner node[:mediawiki][:user]
 480     group node[:mediawiki][:group]
 481     mode 0o644
 482     backup false
 483   end
 484
 485   ssl_certificate new_resource.site do
 486     domains [new_resource.site] + Array(new_resource.aliases)
 487   end
 488
 489   apache_site new_resource.site do
 490     cookbook "mediawiki"
 491     template "apache.erb"
 492     directory site_directory
 493     variables :aliases => Array(new_resource.aliases),
 494               :private_site => new_resource.private_site
 495     reload_apache false
 496   end
 497
 498   # FIXME: needs to run one
 499   execute "#{mediawiki_directory}/extensions/CirrusSearch/maintenance/updateSearchIndexConfig.php" do
 500     action :nothing
 501     command "php extensions/CirrusSearch/maintenance/updateSearchIndexConfig.php"
 502     cwd mediawiki_directory
 503     user node[:mediawiki][:user]
 504     group node[:mediawiki][:group]
 505   end
 506 end
 507
 508 action :update do
 509   mediawiki_directory = "#{site_directory}/w"
 510
 511   template "#{mediawiki_directory}/LocalSettings.php" do
 512     cookbook "mediawiki"
 513     source "LocalSettings.php.erb"
 514     owner node[:mediawiki][:user]
 515     group node[:mediawiki][:group]
 516     mode 0o664
 517     variables :name => new_resource.site,
 518               :directory => mediawiki_directory,
 519               :database_params => database_params,
 520               :mediawiki => mediawiki_params
 521     notifies :run, "execute[#{mediawiki_directory}/maintenance/update.php]"
 522   end
 523
 524   execute "#{mediawiki_directory}/maintenance/update.php" do
 525     action :run
 526     command "php maintenance/update.php --quick"
 527     cwd mediawiki_directory
 528     user node[:mediawiki][:user]
 529     group node[:mediawiki][:group]
 530   end
 531 end
 532
 533 action :delete do
 534   apache_site new_resource.site do
 535     action :delete
 536     reload_apache false
 537   end
 538
 539   declare_resource :directory, site_directory do
 540     action :delete
 541     recursive true
 542   end
 543
 544   mysql_database new_resource.database_name do
 545     action :drop
 546   end
 547
 548   mysql_user "#{new_resource.database_user}@localhost" do
 549     action :drop
 550   end
 551 end
 552
 553 action_class do
 554   def site_directory
 555     new_resource.directory || "/srv/#{new_resource.site}"
 556   end
 557
 558   def cron_name
 559     new_resource.site.tr(".", "_")
 560   end
 561
 562   def database_params
 563     {
 564       :host => "localhost",
 565       :name => new_resource.database_name,
 566       :username => new_resource.database_user,
 567       :password => new_resource.database_password
 568     }
 569   end
 570
 571   def mediawiki_params
 572     {
 573       :sitename => new_resource.sitename,
 574       :metanamespace => new_resource.metanamespace,
 575       :logo => new_resource.logo,
 576       :email_contact => new_resource.email_contact,
 577       :email_sender => new_resource.email_sender,
 578       :email_sender_name => new_resource.email_sender_name,
 579       :commons => new_resource.commons,
 580       :skin => new_resource.skin,
 581       :site_notice => new_resource.site_notice,
 582       :site_readonly => new_resource.site_readonly,
 583       :extra_file_extensions => new_resource.extra_file_extensions,
 584       :private_accounts => new_resource.private_accounts,
 585       :private_site => new_resource.private_site
 586     }
 587   end
 588 end
 589
 590 def after_created
 591   notifies :reload, "service[apache2]" if reload_apache
 592 end