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