diff options
-rw-r--r-- | app/models/project_wiki.rb | 120 | ||||
-rw-r--r-- | app/models/wiki_page.rb | 7 |
2 files changed, 123 insertions, 4 deletions
diff --git a/app/models/project_wiki.rb b/app/models/project_wiki.rb new file mode 100644 index 00000000000..163302a18f7 --- /dev/null +++ b/app/models/project_wiki.rb @@ -0,0 +1,120 @@ +class ProjectWiki + include Gitlab::ShellAdapter + + MARKUPS = { + "Markdown" => :markdown, + "RDoc" => :rdoc + } + + class CouldNotCreateWikiError < StandardError; end + + # Returns a string describing what went wrong after + # an operation fails. + attr_reader :error_message + + 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 + + # Returns the Gollum::Wiki object. + def wiki + @wiki ||= begin + Gollum::Wiki.new(path_to_repo) + rescue Gollum::NoSuchPathError + 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) + if page = wiki.page(title, version) + WikiPage.new(self, page, true) + else + nil + end + end + + def create_page(title, content, format = :markdown, message = nil) + commit = commit_details(:created, message, title) + + wiki.write_page(title, format, content, commit) + 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) + + wiki.update_page(page, page.name, format, content, commit) + end + + def delete_page(page, message = nil) + wiki.delete_page(page, commit_details(:deleted, message, page.title)) + end + + private + + def create_repo! + if init_repo(path_with_namespace) + Gollum::Wiki.new(path_to_repo) + else + raise CouldNotCreateWikiError + end + end + + 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) + + {email: @user.email, name: @user.name, message: commit_message} + 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 +end diff --git a/app/models/wiki_page.rb b/app/models/wiki_page.rb index a7e6fea5ad0..431c1e33f55 100644 --- a/app/models/wiki_page.rb +++ b/app/models/wiki_page.rb @@ -19,7 +19,7 @@ class WikiPage validates :title, presence: true validates :content, presence: true - # The Gitlab GollumWiki instance. + # The Gitlab ProjectWiki instance. attr_reader :wiki # The raw Gollum::Page instance. @@ -118,7 +118,7 @@ class WikiPage # :content - The raw markup content. # :format - Optional symbol representing the # content format. Can be any type - # listed in the GollumWiki::MARKUPS + # listed in the ProjectWiki::MARKUPS # Hash. # :message - Optional commit message to set on # the new page. @@ -135,7 +135,7 @@ class WikiPage # # new_content - The raw markup content to replace the existing. # format - Optional symbol representing the content format. - # See GollumWiki::MARKUPS Hash for available formats. + # See ProjectWiki::MARKUPS Hash for available formats. # message - Optional commit message to set on the new version. # # Returns the String SHA1 of the newly created page @@ -181,5 +181,4 @@ class WikiPage end @persisted end - end |