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