cookbooks/mediawiki/resources/extension.rb

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