BigW Consortium Gitlab

project_wiki.rb 4.21 KB
Newer Older
1 2 3 4
class ProjectWiki
  include Gitlab::ShellAdapter

  MARKUPS = {
5
    'Markdown' => :markdown,
6 7
    'RDoc'     => :rdoc,
    'AsciiDoc' => :asciidoc
8
  }.freeze unless defined?(MARKUPS)
9

10
  CouldNotCreateWikiError = Class.new(StandardError)
11 12 13 14

  # Returns a string describing what went wrong after
  # an operation fails.
  attr_reader :error_message
15
  attr_reader :project
16 17 18 19 20 21

  def initialize(project, user = nil)
    @project = project
    @user = user
  end

Douwe Maan committed
22 23 24
  delegate :empty?, to: :pages
  delegate :repository_storage_path, to: :project

25 26 27 28 29 30 31 32
  def path
    @project.path + '.wiki'
  end

  def path_with_namespace
    @project.path_with_namespace + ".wiki"
  end

33 34 35 36
  def web_url
    Gitlab::Routing.url_helpers.namespace_project_wiki_url(@project.namespace, @project, :home)
  end

37 38 39 40 41 42 43 44 45 46 47 48
  def url_to_repo
    gitlab_shell.url_to_repo(path_with_namespace)
  end

  def ssh_url_to_repo
    url_to_repo
  end

  def http_url_to_repo
    [Gitlab.config.gitlab.url, "/", path_with_namespace, ".git"].join('')
  end

49
  def wiki_base_path
50
    [Gitlab.config.gitlab.relative_url_root, "/", @project.path_with_namespace, "/wikis"].join('')
51 52
  end

53 54 55 56
  # Returns the Gollum::Wiki object.
  def wiki
    @wiki ||= begin
      Gollum::Wiki.new(path_to_repo)
57
    rescue Rugged::OSError
58 59 60 61
      create_repo!
    end
  end

62 63 64 65
  def repository_exists?
    !!repository.exists?
  end

66 67 68 69 70 71 72 73 74 75 76 77 78 79
  # Returns an Array of Gitlab WikiPage instances or an
  # empty Array if this Wiki has no pages.
  def pages
    wiki.pages.map { |page| WikiPage.new(self, page, true) }
  end

  # Finds a page within the repository based on a tile
  # or slug.
  #
  # title - The human readable or parameterized title of
  #         the page.
  #
  # Returns an initialized WikiPage instance or nil
  def find_page(title, version = nil)
80 81
    page_title, page_dir = page_title_and_dir(title)
    if page = wiki.page(page_title, version, page_dir)
82 83 84 85 86 87
      WikiPage.new(self, page, true)
    else
      nil
    end
  end

88 89 90 91 92 93 94 95 96
  def find_file(name, version = nil, try_on_disk = true)
    version = wiki.ref if version.nil? # Gollum::Wiki#file ?
    if wiki_file = wiki.file(name, version, try_on_disk)
      wiki_file
    else
      nil
    end
  end

97 98 99
  def create_page(title, content, format = :markdown, message = nil)
    commit = commit_details(:created, message, title)

100
    wiki.write_page(title, format.to_sym, content, commit)
101 102

    update_project_activity
103 104 105 106 107 108 109 110
  rescue Gollum::DuplicatePageError => e
    @error_message = "Duplicate page: #{e.message}"
    return false
  end

  def update_page(page, content, format = :markdown, message = nil)
    commit = commit_details(:updated, message, page.title)

111
    wiki.update_page(page, page.name, format.to_sym, content, commit)
112 113

    update_project_activity
114 115 116 117
  end

  def delete_page(page, message = nil)
    wiki.delete_page(page, commit_details(:deleted, message, page.title))
118 119

    update_project_activity
120 121
  end

122
  def page_title_and_dir(title)
123
    title_array = title.split("/")
124
    title = title_array.pop
125
    [title, title_array.join("/")]
126 127
  end

Dmitriy Zaporozhets committed
128
  def search_files(query)
129
    repository.search_files_by_content(query, default_branch)
Dmitriy Zaporozhets committed
130 131 132
  end

  def repository
133
    @repository ||= Repository.new(path_with_namespace, @project)
Dmitriy Zaporozhets committed
134 135 136 137 138 139
  end

  def default_branch
    wiki.class.default_ref
  end

140 141
  def create_repo!
    if init_repo(path_with_namespace)
142
      wiki = Gollum::Wiki.new(path_to_repo)
143 144 145
    else
      raise CouldNotCreateWikiError
    end
146 147 148 149

    repository.after_create

    wiki
150
  end
Gabriel Mazetto committed
151

152 153 154 155 156 157
  def hook_attrs
    {
      web_url: web_url,
      git_ssh_url: ssh_url_to_repo,
      git_http_url: http_url_to_repo,
      path_with_namespace: path_with_namespace,
Gabriel Mazetto committed
158
      default_branch: default_branch
159 160
    }
  end
161

162 163
  private

164
  def init_repo(path_with_namespace)
165
    gitlab_shell.add_repository(project.repository_storage_path, path_with_namespace)
166 167 168 169 170
  end

  def commit_details(action, message = nil, title = nil)
    commit_message = message || default_message(action, title)

171
    { email: @user.email, name: @user.name, message: commit_message }
172 173 174 175 176 177 178
  end

  def default_message(action, title)
    "#{@user.username} #{action} page: #{title}"
  end

  def path_to_repo
179
    @path_to_repo ||= File.join(project.repository_storage_path, "#{path_with_namespace}.git")
180
  end
181 182 183 184

  def update_project_activity
    @project.touch(:last_activity_at)
  end
185
end