project_wiki.rb 3.7 KB
Newer Older
D
Dmitriy Zaporozhets 已提交
1 2 3 4
class ProjectWiki
  include Gitlab::ShellAdapter

  MARKUPS = {
5
    'Markdown' => :markdown,
6 7
    'RDoc'     => :rdoc,
    'AsciiDoc' => :asciidoc
8
  } unless defined?(MARKUPS)
D
Dmitriy Zaporozhets 已提交
9 10 11 12 13 14

  class CouldNotCreateWikiError < StandardError; end

  # Returns a string describing what went wrong after
  # an operation fails.
  attr_reader :error_message
V
Valery Sizov 已提交
15
  attr_reader :project
D
Dmitriy Zaporozhets 已提交
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

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

  def path
    @project.path + '.wiki'
  end

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

  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

42
  def wiki_base_path
43
    ["/", @project.path_with_namespace, "/wikis"].join('')
44 45
  end

D
Dmitriy Zaporozhets 已提交
46 47 48 49
  # Returns the Gollum::Wiki object.
  def wiki
    @wiki ||= begin
      Gollum::Wiki.new(path_to_repo)
50
    rescue Rugged::OSError
D
Dmitriy Zaporozhets 已提交
51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
      create_repo!
    end
  end

  def empty?
    pages.empty?
  end

  # 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)
M
Marin Jankovski 已提交
73 74
    page_title, page_dir = page_title_and_dir(title)
    if page = wiki.page(page_title, version, page_dir)
D
Dmitriy Zaporozhets 已提交
75 76 77 78 79 80
      WikiPage.new(self, page, true)
    else
      nil
    end
  end

81 82 83 84 85 86 87 88 89
  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

D
Dmitriy Zaporozhets 已提交
90 91 92
  def create_page(title, content, format = :markdown, message = nil)
    commit = commit_details(:created, message, title)

93
    wiki.write_page(title, format.to_sym, content, commit)
94 95

    update_project_activity
D
Dmitriy Zaporozhets 已提交
96 97 98 99 100 101 102 103
  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)

104
    wiki.update_page(page, page.name, format.to_sym, content, commit)
105 106

    update_project_activity
D
Dmitriy Zaporozhets 已提交
107 108 109 110
  end

  def delete_page(page, message = nil)
    wiki.delete_page(page, commit_details(:deleted, message, page.title))
111 112

    update_project_activity
D
Dmitriy Zaporozhets 已提交
113 114
  end

M
Marin Jankovski 已提交
115
  def page_title_and_dir(title)
116
    title_array = title.split("/")
M
Marin Jankovski 已提交
117
    title = title_array.pop
S
Stan Hu 已提交
118
    [title, title_array.join("/")]
M
Marin Jankovski 已提交
119 120
  end

D
Dmitriy Zaporozhets 已提交
121 122 123 124 125
  def search_files(query)
    repository.search_files(query, default_branch)
  end

  def repository
126
    @repository ||= Repository.new(path_with_namespace, @project)
D
Dmitriy Zaporozhets 已提交
127 128 129 130 131 132
  end

  def default_branch
    wiki.class.default_ref
  end

D
Dmitriy Zaporozhets 已提交
133 134
  def create_repo!
    if init_repo(path_with_namespace)
135
      wiki = Gollum::Wiki.new(path_to_repo)
D
Dmitriy Zaporozhets 已提交
136 137 138
    else
      raise CouldNotCreateWikiError
    end
139 140 141 142

    repository.after_create

    wiki
D
Dmitriy Zaporozhets 已提交
143 144
  end

145 146
  private

D
Dmitriy Zaporozhets 已提交
147 148 149 150 151 152 153
  def init_repo(path_with_namespace)
    gitlab_shell.add_repository(path_with_namespace)
  end

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

154
    { email: @user.email, name: @user.name, message: commit_message }
D
Dmitriy Zaporozhets 已提交
155 156 157 158 159 160 161 162 163
  end

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

  def path_to_repo
    @path_to_repo ||= File.join(Gitlab.config.gitlab_shell.repos_path, "#{path_with_namespace}.git")
  end
164 165 166 167

  def update_project_activity
    @project.touch(:last_activity_at)
  end
D
Dmitriy Zaporozhets 已提交
168
end