2014-04-09 11:35:26 +00:00
|
|
|
class ProjectWiki
|
|
|
|
include Gitlab::ShellAdapter
|
2017-07-22 00:37:22 +00:00
|
|
|
include Storage::LegacyProjectWiki
|
2014-04-09 11:35:26 +00:00
|
|
|
|
|
|
|
MARKUPS = {
|
2016-02-28 12:11:43 +00:00
|
|
|
'Markdown' => :markdown,
|
2014-08-22 10:33:58 +00:00
|
|
|
'RDoc' => :rdoc,
|
|
|
|
'AsciiDoc' => :asciidoc
|
2017-02-21 23:32:18 +00:00
|
|
|
}.freeze unless defined?(MARKUPS)
|
2014-04-09 11:35:26 +00:00
|
|
|
|
2017-03-01 11:00:37 +00:00
|
|
|
CouldNotCreateWikiError = Class.new(StandardError)
|
2014-04-09 11:35:26 +00:00
|
|
|
|
|
|
|
# Returns a string describing what went wrong after
|
|
|
|
# an operation fails.
|
|
|
|
attr_reader :error_message
|
2016-01-22 09:24:38 +00:00
|
|
|
attr_reader :project
|
2014-04-09 11:35:26 +00:00
|
|
|
|
|
|
|
def initialize(project, user = nil)
|
|
|
|
@project = project
|
|
|
|
@user = user
|
|
|
|
end
|
|
|
|
|
2017-02-22 22:35:08 +00:00
|
|
|
delegate :empty?, to: :pages
|
2017-11-15 14:20:36 +00:00
|
|
|
delegate :repository_storage_path, :hashed_storage?, to: :project
|
2017-02-22 22:35:08 +00:00
|
|
|
|
2014-04-09 11:35:26 +00:00
|
|
|
def path
|
|
|
|
@project.path + '.wiki'
|
|
|
|
end
|
|
|
|
|
2017-07-22 00:37:22 +00:00
|
|
|
def full_path
|
2017-07-20 09:34:09 +00:00
|
|
|
@project.full_path + '.wiki'
|
2014-04-09 11:35:26 +00:00
|
|
|
end
|
|
|
|
|
2017-07-22 00:37:22 +00:00
|
|
|
# @deprecated use full_path when you need it for an URL route or disk_path when you want to point to the filesystem
|
|
|
|
alias_method :path_with_namespace, :full_path
|
|
|
|
|
2016-05-13 07:21:01 +00:00
|
|
|
def web_url
|
2017-06-29 17:06:35 +00:00
|
|
|
Gitlab::Routing.url_helpers.project_wiki_url(@project, :home)
|
2016-05-13 07:21:01 +00:00
|
|
|
end
|
|
|
|
|
2014-04-09 11:35:26 +00:00
|
|
|
def url_to_repo
|
2017-07-22 00:37:22 +00:00
|
|
|
gitlab_shell.url_to_repo(full_path)
|
2014-04-09 11:35:26 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def ssh_url_to_repo
|
|
|
|
url_to_repo
|
|
|
|
end
|
|
|
|
|
2017-05-30 12:18:58 +00:00
|
|
|
def http_url_to_repo
|
2017-07-22 00:37:22 +00:00
|
|
|
"#{Gitlab.config.gitlab.url}/#{full_path}.git"
|
2014-04-09 11:35:26 +00:00
|
|
|
end
|
|
|
|
|
2016-01-12 04:05:18 +00:00
|
|
|
def wiki_base_path
|
2017-07-22 00:37:22 +00:00
|
|
|
[Gitlab.config.gitlab.relative_url_root, '/', @project.full_path, '/wikis'].join('')
|
2016-01-12 04:05:18 +00:00
|
|
|
end
|
|
|
|
|
2017-10-03 16:58:33 +00:00
|
|
|
# Returns the Gitlab::Git::Wiki object.
|
2014-04-09 11:35:26 +00:00
|
|
|
def wiki
|
|
|
|
@wiki ||= begin
|
2017-10-03 16:58:33 +00:00
|
|
|
gl_repository = Gitlab::GlRepository.gl_repository(project, true)
|
|
|
|
raw_repository = Gitlab::Git::Repository.new(project.repository_storage, disk_path + '.git', gl_repository)
|
|
|
|
|
|
|
|
create_repo!(raw_repository) unless raw_repository.exists?
|
|
|
|
|
|
|
|
Gitlab::Git::Wiki.new(raw_repository)
|
2014-04-09 11:35:26 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2016-08-13 01:56:40 +00:00
|
|
|
def repository_exists?
|
|
|
|
!!repository.exists?
|
|
|
|
end
|
2017-07-06 19:21:08 +00:00
|
|
|
|
|
|
|
def has_home_page?
|
|
|
|
!!find_page('home')
|
|
|
|
end
|
2016-08-13 01:56:40 +00:00
|
|
|
|
2014-04-09 11:35:26 +00:00
|
|
|
# Returns an Array of Gitlab WikiPage instances or an
|
|
|
|
# empty Array if this Wiki has no pages.
|
2017-11-17 11:48:32 +00:00
|
|
|
def pages(limit: nil)
|
|
|
|
wiki.pages(limit: limit).map { |page| WikiPage.new(self, page, true) }
|
2014-04-09 11:35:26 +00:00
|
|
|
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)
|
2014-04-28 14:22:31 +00:00
|
|
|
page_title, page_dir = page_title_and_dir(title)
|
2017-10-03 16:58:33 +00:00
|
|
|
|
|
|
|
if page = wiki.page(title: page_title, version: version, dir: page_dir)
|
2014-04-09 11:35:26 +00:00
|
|
|
WikiPage.new(self, page, true)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2017-10-03 16:58:33 +00:00
|
|
|
def find_file(name, version = nil)
|
|
|
|
wiki.file(name, version)
|
2014-03-28 20:15:25 +00:00
|
|
|
end
|
|
|
|
|
2014-04-09 11:35:26 +00:00
|
|
|
def create_page(title, content, format = :markdown, message = nil)
|
|
|
|
commit = commit_details(:created, message, title)
|
|
|
|
|
2016-02-28 12:11:43 +00:00
|
|
|
wiki.write_page(title, format.to_sym, content, commit)
|
2015-11-15 19:32:28 +00:00
|
|
|
|
|
|
|
update_project_activity
|
2017-10-03 16:58:33 +00:00
|
|
|
rescue Gitlab::Git::Wiki::DuplicatePageError => e
|
2014-04-09 11:35:26 +00:00
|
|
|
@error_message = "Duplicate page: #{e.message}"
|
|
|
|
return false
|
|
|
|
end
|
|
|
|
|
2017-07-23 08:19:10 +00:00
|
|
|
def update_page(page, content:, title: nil, format: :markdown, message: nil)
|
2014-04-09 11:35:26 +00:00
|
|
|
commit = commit_details(:updated, message, page.title)
|
|
|
|
|
2017-10-03 16:58:33 +00:00
|
|
|
wiki.update_page(page.path, title || page.name, format.to_sym, content, commit)
|
2015-11-15 19:32:28 +00:00
|
|
|
|
|
|
|
update_project_activity
|
2014-04-09 11:35:26 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def delete_page(page, message = nil)
|
2018-02-05 17:17:21 +00:00
|
|
|
return unless page
|
|
|
|
|
2017-10-03 16:58:33 +00:00
|
|
|
wiki.delete_page(page.path, commit_details(:deleted, message, page.title))
|
2015-11-15 19:32:28 +00:00
|
|
|
|
|
|
|
update_project_activity
|
2014-04-09 11:35:26 +00:00
|
|
|
end
|
|
|
|
|
2018-01-25 15:24:11 +00:00
|
|
|
def page_formatted_data(page)
|
|
|
|
page_title, page_dir = page_title_and_dir(page.title)
|
|
|
|
|
|
|
|
wiki.page_formatted_data(title: page_title, dir: page_dir, version: page.version)
|
|
|
|
end
|
|
|
|
|
2014-04-28 14:22:31 +00:00
|
|
|
def page_title_and_dir(title)
|
2018-02-05 17:17:21 +00:00
|
|
|
return unless title
|
|
|
|
|
2016-05-11 02:58:06 +00:00
|
|
|
title_array = title.split("/")
|
2014-04-28 14:22:31 +00:00
|
|
|
title = title_array.pop
|
2015-03-22 01:04:29 +00:00
|
|
|
[title, title_array.join("/")]
|
2014-04-28 14:22:31 +00:00
|
|
|
end
|
|
|
|
|
2014-09-25 10:56:23 +00:00
|
|
|
def search_files(query)
|
2016-11-10 17:27:09 +00:00
|
|
|
repository.search_files_by_content(query, default_branch)
|
2014-09-25 10:56:23 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def repository
|
2017-10-19 16:27:03 +00:00
|
|
|
@repository ||= Repository.new(full_path, @project, disk_path: disk_path, is_wiki: true)
|
2014-09-25 10:56:23 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def default_branch
|
|
|
|
wiki.class.default_ref
|
|
|
|
end
|
|
|
|
|
2017-06-28 13:42:59 +00:00
|
|
|
def ensure_repository
|
2017-10-03 16:58:33 +00:00
|
|
|
raise CouldNotCreateWikiError unless wiki.repository_exists?
|
2017-06-28 13:42:59 +00:00
|
|
|
end
|
|
|
|
|
2016-05-13 07:21:01 +00:00
|
|
|
def hook_attrs
|
|
|
|
{
|
|
|
|
web_url: web_url,
|
|
|
|
git_ssh_url: ssh_url_to_repo,
|
|
|
|
git_http_url: http_url_to_repo,
|
2017-07-22 00:37:22 +00:00
|
|
|
path_with_namespace: full_path,
|
2016-05-27 23:31:03 +00:00
|
|
|
default_branch: default_branch
|
2016-05-13 07:21:01 +00:00
|
|
|
}
|
|
|
|
end
|
2014-04-09 11:35:26 +00:00
|
|
|
|
2016-03-18 14:31:19 +00:00
|
|
|
private
|
|
|
|
|
2017-10-03 16:58:33 +00:00
|
|
|
def create_repo!(raw_repository)
|
2017-09-28 17:07:22 +00:00
|
|
|
gitlab_shell.add_repository(project.repository_storage, disk_path)
|
2017-10-03 16:58:33 +00:00
|
|
|
|
|
|
|
raise CouldNotCreateWikiError unless raw_repository.exists?
|
|
|
|
|
|
|
|
repository.after_create
|
2014-04-09 11:35:26 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def commit_details(action, message = nil, title = nil)
|
|
|
|
commit_message = message || default_message(action, title)
|
|
|
|
|
2017-10-03 16:58:33 +00:00
|
|
|
Gitlab::Git::Wiki::CommitDetails.new(@user.name, @user.email, commit_message)
|
2014-04-09 11:35:26 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def default_message(action, title)
|
|
|
|
"#{@user.username} #{action} page: #{title}"
|
|
|
|
end
|
|
|
|
|
2015-11-15 19:32:28 +00:00
|
|
|
def update_project_activity
|
2017-05-04 01:47:10 +00:00
|
|
|
@project.touch(:last_activity_at, :last_repository_updated_at)
|
2015-11-15 19:32:28 +00:00
|
|
|
end
|
2014-04-09 11:35:26 +00:00
|
|
|
end
|