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