cookbooks/mediawiki/resources/skin.rb

   1 #
   2 # Cookbook:: mediawiki
   3 # Resource:: mediawiki_skin
   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 :skin, :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 :variables, :kind_of => Hash, :default => {}
  27 property :version, :kind_of => String
  28 property :repository, :kind_of => String
  29 property :revision, :kind_of => String
  30 property :update_site, :kind_of => [TrueClass, FalseClass], :default => true
  31 property :legacy, :kind_of => [TrueClass, FalseClass], :default => true
  32
  33 action :create do
  34   if new_resource.source
  35     remote_directory skin_directory do
  36       cookbook "mediawiki"
  37       source new_resource.source
  38       owner node[:mediawiki][:user]
  39       group node[:mediawiki][:group]
  40       mode "755"
  41       files_owner node[:mediawiki][:user]
  42       files_group node[:mediawiki][:group]
  43       files_mode "755"
  44     end
  45   else
  46     skin_repository = new_resource.repository || default_repository
  47     skin_revision = new_resource.revision || "REL#{skin_version}".tr(".", "_")
  48
  49     git skin_directory do
  50       action :sync
  51       repository skin_repository
  52       revision skin_revision
  53       enable_submodules true
  54       user node[:mediawiki][:user]
  55       group node[:mediawiki][:group]
  56       ignore_failure skin_repository.start_with?("https://github.com/wikimedia/mediawiki-skins")
  57     end
  58   end
  59
  60   if new_resource.template
  61     declare_resource :template, "#{mediawiki_directory}/LocalSettings.d/Skin-#{new_resource.skin}.inc.php" do
  62       cookbook "mediawiki"
  63       source new_resource.template
  64       user node[:mediawiki][:user]
  65       group node[:mediawiki][:group]
  66       mode "664"
  67       variables new_resource.variables
  68     end
  69   else
  70     if new_resource.legacy
  71       file_content = "<?php require_once('#{skin_directory}/#{new_resource.skin}.php');\n"
  72       skin_file = "#{skin_directory}/#{new_resource.skin}.php"
  73     else
  74       file_content = "<?php wfLoadSkin('#{new_resource.skin}');\n"
  75       skin_file = "#{skin_directory}/skin.json"
  76     end
  77
  78     file "#{mediawiki_directory}/LocalSettings.d/Skin-#{new_resource.skin}.inc.php" do
  79       content file_content
  80       user node[:mediawiki][:user]
  81       group node[:mediawiki][:group]
  82       mode "664"
  83       only_if { ::File.exist?(skin_file) }
  84     end
  85   end
  86 end
  87
  88 action :delete do
  89   directory skin_directory do
  90     action :delete
  91     recursive true
  92   end
  93
  94   file "#{mediawiki_directory}/LocalSettings.d/Skin-#{new_resource.skin}.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 skin_directory
 109     "#{mediawiki_directory}/skins/#{new_resource.skin}"
 110   end
 111
 112   def skin_version
 113     new_resource.version || node[:mediawiki][:sites][new_resource.site][:version]
 114   end
 115
 116   def default_repository
 117     "https://github.com/wikimedia/mediawiki-skins-#{new_resource.skin}.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