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   mediawiki_skin "MinervaNeue" do # ~FC005
 191     site new_resource.site
 192     update_site false
 193   end
 194
 195   mediawiki_skin "CologneBlue" do # ~FC005
 196     site new_resource.site
 197     update_site false
 198   end
 199
 200   mediawiki_skin "Modern" do
 201     site new_resource.site
 202     update_site false
 203   end
 204
 205   mediawiki_skin "MonoBook" do
 206     site new_resource.site
 207     update_site false
 208   end
 209
 210   mediawiki_skin "Vector" do
 211     site new_resource.site
 212     update_site 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.recaptcha_public_key,
 236                 :private_key => new_resource.recaptcha_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     update_site false
 259   end
 260
 261   mediawiki_extension "Nuke" do
 262     site new_resource.site
 263     update_site false
 264   end
 265
 266   mediawiki_extension "ParserFunctions" do
 267     site new_resource.site
 268     template "mw-ext-ParserFunctions.inc.php.erb"
 269     update_site false
 270   end
 271
 272   mediawiki_extension "PdfHandler" do
 273     site new_resource.site
 274     template "mw-ext-PdfHandler.inc.php.erb"
 275     update_site false
 276   end
 277
 278   mediawiki_extension "Poem" do
 279     site new_resource.site
 280     update_site false
 281   end
 282
 283   mediawiki_extension "Renameuser" do
 284     site new_resource.site
 285     update_site false
 286   end
 287
 288   mediawiki_extension "SimpleAntiSpam" do
 289     site new_resource.site
 290     update_site false
 291     action :delete
 292   end
 293
 294   mediawiki_extension "SpamBlacklist" do
 295     site new_resource.site
 296     template "mw-ext-SpamBlacklist.inc.php.erb"
 297     update_site false
 298   end
 299
 300   mediawiki_extension "SyntaxHighlight_GeSHi" do
 301     site new_resource.site
 302     template "mw-ext-SyntaxHighlight.inc.php.erb"
 303     update_site false
 304   end
 305
 306   mediawiki_extension "TitleBlacklist" do
 307     site new_resource.site
 308     template "mw-ext-TitleBlacklist.inc.php.erb"
 309     update_site false
 310   end
 311
 312   mediawiki_extension "WikiEditor" do
 313     site new_resource.site
 314     update_site false
 315   end
 316
 317   mediawiki_extension "Babel" do
 318     site new_resource.site
 319     template "mw-ext-Babel.inc.php.erb"
 320     update_site false
 321   end
 322
 323   mediawiki_extension "cldr" do
 324     site new_resource.site
 325     template "mw-ext-cldr.inc.php.erb"
 326     update_site false
 327   end
 328
 329   mediawiki_extension "CleanChanges" do
 330     site new_resource.site
 331     template "mw-ext-CleanChanges.inc.php.erb"
 332     update_site false
 333   end
 334
 335   mediawiki_extension "LocalisationUpdate" do
 336     site new_resource.site
 337     template "mw-ext-LocalisationUpdate.inc.php.erb"
 338     update_site false
 339   end
 340
 341   # LocalisationUpdate Update Cron
 342   # template "/etc/cron.d/mediawiki-#{name}-LocalisationUpdate" do
 343   #   cookbook "mediawiki"
 344   #   source "mediawiki-LocalisationUpdate.cron.erb"
 345   #   owner "root"
 346   #   group "root"
 347   #   mode 0755
 348   #   variables :name => name, :directory => site_directory, :user => node[:mediawiki][:user]
 349   # end
 350
 351   # mediawiki_extension "Translate" do
 352   #   site new_resource.site
 353   #   template "mw-ext-Translate.inc.php.erb"
 354   #   update_site false
 355   # end
 356
 357   mediawiki_extension "UniversalLanguageSelector" do
 358     site new_resource.site
 359     template "mw-ext-UniversalLanguageSelector.inc.php.erb"
 360     update_site false
 361   end
 362
 363   mediawiki_extension "AntiSpoof" do
 364     site new_resource.site
 365     template "mw-ext-AntiSpoof.inc.php.erb"
 366     compose true
 367     update_site false
 368   end
 369
 370   mediawiki_extension "AbuseFilter" do
 371     site new_resource.site
 372     template "mw-ext-AbuseFilter.inc.php.erb"
 373     compose true
 374     update_site false
 375   end
 376
 377   mediawiki_extension "CheckUser" do
 378     site new_resource.site
 379     template "mw-ext-CheckUser.inc.php.erb"
 380     update_site false
 381   end
 382
 383   mediawiki_extension "DismissableSiteNotice" do
 384     site new_resource.site
 385     update_site false
 386   end
 387
 388   mediawiki_extension "Elastica" do
 389     site new_resource.site
 390     compose true
 391     update_site false
 392   end
 393
 394   mediawiki_extension "CirrusSearch" do
 395     site new_resource.site
 396     compose true
 397     template "mw-ext-CirrusSearch.inc.php.erb"
 398     update_site false
 399   end
 400
 401   mediawiki_extension "osmtaginfo" do
 402     site new_resource.site
 403     template "mw-ext-osmtaginfo.inc.php.erb"
 404     repository "git://github.com/Firefishy/osmtaginfo.git"
 405     tag "live"
 406     update_site false
 407   end
 408
 409   mediawiki_extension "SimpleMap" do
 410     site new_resource.site
 411     template "mw-ext-SimpleMap.inc.php.erb"
 412     repository "git://github.com/Firefishy/SimpleMap.git"
 413     tag "live"
 414     update_site false
 415   end
 416
 417   mediawiki_extension "SlippyMap" do
 418     site new_resource.site
 419     template "mw-ext-SlippyMap.inc.php.erb"
 420     repository "git://github.com/Firefishy/SlippyMap.git"
 421     tag "live"
 422     update_site false
 423   end
 424
 425   mediawiki_extension "Mantle" do
 426     site new_resource.site
 427     update_site false
 428     action :delete
 429   end
 430
 431   mediawiki_extension "DisableAccount" do
 432     site new_resource.site
 433     template "mw-ext-DisableAccount.inc.php.erb"
 434     update_site false
 435   end
 436
 437   mediawiki_extension "VisualEditor" do
 438     site new_resource.site
 439     template "mw-ext-VisualEditor.inc.php.erb"
 440     update_site false
 441   end
 442
 443   mediawiki_extension "TemplateData" do
 444     site new_resource.site
 445     update_site false
 446   end
 447
 448   cookbook_file "#{site_directory}/cc-wiki.png" do
 449     cookbook "mediawiki"
 450     owner node[:mediawiki][:user]
 451     group node[:mediawiki][:group]
 452     mode 0o644
 453     backup false
 454   end
 455
 456   cookbook_file "#{site_directory}/googled06a989d1ccc8364.html" do
 457     cookbook "mediawiki"
 458     owner node[:mediawiki][:user]
 459     group node[:mediawiki][:group]
 460     mode 0o644
 461     backup false
 462   end
 463
 464   cookbook_file "#{site_directory}/googlefac54c35e800caab.html" do
 465     cookbook "mediawiki"
 466     owner node[:mediawiki][:user]
 467     group node[:mediawiki][:group]
 468     mode 0o644
 469     backup false
 470   end
 471
 472   ssl_certificate new_resource.site do
 473     domains [new_resource.site] + Array(new_resource.aliases)
 474   end
 475
 476   apache_site new_resource.site do
 477     cookbook "mediawiki"
 478     template "apache.erb"
 479     directory site_directory
 480     variables :aliases => Array(new_resource.aliases),
 481               :private_site => new_resource.private_site
 482     reload_apache false
 483   end
 484
 485   # FIXME: needs to run one
 486   execute "#{mediawiki_directory}/extensions/CirrusSearch/maintenance/updateSearchIndexConfig.php" do
 487     action :nothing
 488     command "php extensions/CirrusSearch/maintenance/updateSearchIndexConfig.php"
 489     cwd mediawiki_directory
 490     user node[:mediawiki][:user]
 491     group node[:mediawiki][:group]
 492   end
 493 end
 494
 495 action :update do
 496   mediawiki_directory = "#{site_directory}/w"
 497
 498   template "#{mediawiki_directory}/LocalSettings.php" do
 499     cookbook "mediawiki"
 500     source "LocalSettings.php.erb"
 501     owner node[:mediawiki][:user]
 502     group node[:mediawiki][:group]
 503     mode 0o664
 504     variables :name => new_resource.site,
 505               :directory => mediawiki_directory,
 506               :database_params => database_params,
 507               :mediawiki => mediawiki_params
 508     notifies :run, "execute[#{mediawiki_directory}/maintenance/update.php]"
 509   end
 510
 511   execute "#{mediawiki_directory}/maintenance/update.php" do
 512     action :run
 513     command "php maintenance/update.php --quick"
 514     cwd mediawiki_directory
 515     user node[:mediawiki][:user]
 516     group node[:mediawiki][:group]
 517   end
 518 end
 519
 520 action :delete do
 521   apache_site new_resource.site do
 522     action :delete
 523     reload_apache false
 524   end
 525
 526   declare_resource :directory, site_directory do
 527     action :delete
 528     recursive true
 529   end
 530
 531   mysql_database new_resource.database_name do
 532     action :drop
 533   end
 534
 535   mysql_user "#{new_resource.database_user}@localhost" do
 536     action :drop
 537   end
 538 end
 539
 540 action_class do
 541   def site_directory
 542     new_resource.directory || "/srv/#{new_resource.site}"
 543   end
 544
 545   def cron_name
 546     new_resource.site.tr(".", "_")
 547   end
 548
 549   def database_params
 550     {
 551       :host => "localhost",
 552       :name => new_resource.database_name,
 553       :username => new_resource.database_user,
 554       :password => new_resource.database_password
 555     }
 556   end
 557
 558   def mediawiki_params
 559     {
 560       :sitename => new_resource.sitename,
 561       :metanamespace => new_resource.metanamespace,
 562       :logo => new_resource.logo,
 563       :email_contact => new_resource.email_contact,
 564       :email_sender => new_resource.email_sender,
 565       :email_sender_name => new_resource.email_sender_name,
 566       :commons => new_resource.commons,
 567       :skin => new_resource.skin,
 568       :site_notice => new_resource.site_notice,
 569       :site_readonly => new_resource.site_readonly,
 570       :extra_file_extensions => new_resource.extra_file_extensions,
 571       :private_accounts => new_resource.private_accounts,
 572       :private_site => new_resource.private_site
 573     }
 574   end
 575 end
 576
 577 def after_created
 578   notifies :reload, "service[apache2]" if reload_apache
 579 end