cookbooks/mediawiki/resources/extension.rb

   1 #
   2 # Cookbook Name:: mediawiki
   3 # Resource:: mediawiki_extension
   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 :extension, :kind_of => String, :name_attribute => true
  23 property :site, :kind_of => String, :required => true
  24 property :source, :kind_of => String
  25 property :template, :kind_of => String
  26 property :template_cookbook, :kind_of => String, :default => "mediawiki"
  27 property :variables, :kind_of => Hash, :default => {}
  28 property :version, :kind_of => String
  29 property :repository, :kind_of => String
  30 property :tag, :kind_of => String
  31 property :reference, :kind_of => String
  32 property :compose, :kind_of => [TrueClass, FalseClass], :default => false
  33 property :update_site, :kind_of => [TrueClass, FalseClass], :default => true
  34
  35 action :create do
  36   if new_resource.source
  37     remote_directory extension_directory do
  38       cookbook "mediawiki"
  39       source new_resource.source
  40       owner node[:mediawiki][:user]
  41       group node[:mediawiki][:group]
  42       mode 0o755
  43       files_owner node[:mediawiki][:user]
  44       files_group node[:mediawiki][:group]
  45       files_mode 0o755
  46     end
  47   else
  48     extension_repository = new_resource.repository || default_repository
  49     extension_reference = if new_resource.reference
  50                             new_resource.reference
  51                           elsif new_resource.tag
  52                             "refs/tags/#{new_resource.tag}"
  53                           else
  54                             "REL#{extension_version}".tr(".", "_")
  55                           end
  56
  57     git extension_directory do
  58       action :sync
  59       repository extension_repository
  60       reference extension_reference
  61       enable_submodules true
  62       user node[:mediawiki][:user]
  63       group node[:mediawiki][:group]
  64       ignore_failure extension_repository.start_with?("git://github.com/wikimedia/mediawiki-extensions")
  65     end
  66   end
  67
  68   if new_resource.template # ~FC023
  69     declare_resource :template, "#{mediawiki_directory}/LocalSettings.d/Ext-#{new_resource.extension}.inc.php" do
  70       cookbook new_resource.template_cookbook
  71       source new_resource.template
  72       user node[:mediawiki][:user]
  73       group node[:mediawiki][:group]
  74       mode 0o664
  75       variables new_resource.variables
  76     end
  77   else
  78     extension_script = "#{extension_directory}/#{new_resource.extension}.php"
  79
  80     file "#{mediawiki_directory}/LocalSettings.d/Ext-#{new_resource.extension}.inc.php" do
  81       content "<?php wfLoadExtension( '#{new_resource.extension}' );\n"
  82       user node[:mediawiki][:user]
  83       group node[:mediawiki][:group]
  84       mode 0o664
  85       only_if { ::File.exist?(extension_script) }
  86     end
  87   end
  88
  89   if new_resource.compose # ~FC023
  90     execute "composer-#{new_resource.extension}" do
  91       action :nothing
  92       command "composer install --no-dev"
  93       cwd extension_directory
  94       user node[:mediawiki][:user]
  95       group node[:mediawiki][:group]
  96       subscribes :run, "git[#{extension_directory}]"
  97     end
  98   end
  99 end
 100
 101 action :delete do
 102   directory extension_directory do
 103     action :delete
 104     recursive true
 105   end
 106
 107   file "#{mediawiki_directory}/LocalSettings.d/Ext-#{new_resource.extension}.inc.php" do
 108     action :delete
 109   end
 110 end
 111
 112 action_class do
 113   def site_directory
 114     node[:mediawiki][:sites][new_resource.site][:directory]
 115   end
 116
 117   def mediawiki_directory
 118     "#{site_directory}/w"
 119   end
 120
 121   def extension_directory
 122     "#{mediawiki_directory}/extensions/#{new_resource.extension}"
 123   end
 124
 125   def extension_version
 126     new_resource.version || node[:mediawiki][:sites][new_resource.site][:version]
 127   end
 128
 129   def default_repository
 130     "git://github.com/wikimedia/mediawiki-extensions-#{new_resource.extension}.git"
 131   end
 132 end
 133
 134 def after_created
 135   if update_site
 136     notifies :update, "mediawiki_site[#{site}]"
 137   else
 138     site_directory = node[:mediawiki][:sites][site][:directory]
 139
 140     notifies :create, "template[#{site_directory}/w/LocalSettings.php]"
 141     notifies :run, "execute[#{site_directory}/w/maintenance/update.php]"
 142   end
 143 end