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