summaryrefslogtreecommitdiff
path: root/app/services/projects/update_pages_configuration_service.rb
blob: 67d388dc8a33fa5f229fd047241eb21de590c334 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# frozen_string_literal: true

module Projects
  class UpdatePagesConfigurationService < BaseService
    include Gitlab::Utils::StrongMemoize

    attr_reader :project

    def initialize(project)
      @project = project
    end

    def execute
      # If the pages were never deployed, we can't write out the config, as the
      # directory would not exist.
      # https://gitlab.com/gitlab-org/gitlab/-/issues/235139
      return success unless project.pages_deployed?

      unless file_equals?(pages_config_file, pages_config_json)
        update_file(pages_config_file, pages_config_json)
        reload_daemon
      end

      success
    end

    private

    def pages_config_json
      strong_memoize(:pages_config_json) do
        pages_config.to_json
      end
    end

    def pages_config
      {
        domains: pages_domains_config,
        https_only: project.pages_https_only?,
        id: project.project_id,
        access_control: !project.public_pages?
      }
    end

    def pages_domains_config
      enabled_pages_domains.map do |domain|
        {
          domain: domain.domain,
          certificate: domain.certificate,
          key: domain.key,
          https_only: project.pages_https_only? && domain.https?,
          id: project.project_id,
          access_control: !project.public_pages?
        }
      end
    end

    def enabled_pages_domains
      if Gitlab::CurrentSettings.pages_domain_verification_enabled?
        project.pages_domains.enabled
      else
        project.pages_domains
      end
    end

    def reload_daemon
      # GitLab Pages daemon constantly watches for modification time of `pages.path`
      # It reloads configuration when `pages.path` is modified
      update_file(pages_update_file, SecureRandom.hex(64))
    end

    def pages_path
      @pages_path ||= project.pages_path
    end

    def pages_config_file
      File.join(pages_path, 'config.json')
    end

    def pages_update_file
      File.join(::Settings.pages.path, '.update')
    end

    def update_file(file, data)
      temp_file = "#{file}.#{SecureRandom.hex(16)}"
      File.open(temp_file, 'w') do |f|
        f.write(data)
      end
      FileUtils.move(temp_file, file, force: true)
    ensure
      # In case if the updating fails
      FileUtils.remove(temp_file, force: true)
    end

    def file_equals?(file, data)
      existing_data = read_file(file)
      data == existing_data.to_s
    end

    def read_file(file)
      File.open(file, 'r') do |f|
        f.read
      end
    rescue
      nil
    end
  end
end