summaryrefslogtreecommitdiff
path: root/app/models/integrations/confluence.rb
blob: 30f73496993de17febd5c7b8c2ed31dea68cac16 (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
# frozen_string_literal: true

module Integrations
  class Confluence < Integration
    include ActionView::Helpers::UrlHelper

    VALID_SCHEME_MATCH = %r{\Ahttps?\Z}.freeze
    VALID_HOST_MATCH = %r{\A.+\.atlassian\.net\Z}.freeze
    VALID_PATH_MATCH = %r{\A/wiki(/|\Z)}.freeze

    prop_accessor :confluence_url

    validates :confluence_url, presence: true, if: :activated?
    validate :validate_confluence_url_is_cloud, if: :activated?

    after_commit :cache_project_has_confluence

    def self.to_param
      'confluence'
    end

    def self.supported_events
      %w()
    end

    def title
      s_('ConfluenceService|Confluence Workspace')
    end

    def description
      s_('ConfluenceService|Link to a Confluence Workspace from the sidebar.')
    end

    def help
      return unless project&.wiki_enabled?

      if activated?
        wiki_url = project.wiki.web_url

        s_(
          'ConfluenceService|Your GitLab wiki is still available at %{wiki_link}. To re-enable the link to the GitLab wiki, disable this integration.' %
          { wiki_link: link_to(wiki_url, wiki_url) }
        ).html_safe
      else
        s_('ConfluenceService|Link to a Confluence Workspace from the sidebar. Enabling this integration replaces the "Wiki" sidebar link with a link to the Confluence Workspace. The GitLab wiki is still available at the original URL.').html_safe
      end
    end

    def fields
      [
        {
          type: 'text',
          name: 'confluence_url',
          title: s_('Confluence Cloud Workspace URL'),
          placeholder: 'https://example.atlassian.net/wiki',
          required: true
        }
      ]
    end

    def can_test?
      false
    end

    private

    def validate_confluence_url_is_cloud
      unless confluence_uri_valid?
        errors.add(:confluence_url, 'URL must be to a Confluence Cloud Workspace hosted on atlassian.net')
      end
    end

    def confluence_uri_valid?
      return false unless confluence_url

      uri = URI.parse(confluence_url)

      (uri.scheme&.match(VALID_SCHEME_MATCH) &&
        uri.host&.match(VALID_HOST_MATCH) &&
        uri.path&.match(VALID_PATH_MATCH)).present?

    rescue URI::InvalidURIError
      false
    end

    def cache_project_has_confluence
      return unless project && !project.destroyed?

      project.project_setting.save! unless project.project_setting.persisted?
      project.project_setting.update_column(:has_confluence, active?)
    end
  end
end