require 'active_model/naming' module Scrivito # @api public # This class represents a CMS workspace, called "working copy" in the UI. A working copy lets # editors create and modify content independently of the published content or other working copies. # On creation, a working copy is based on the currently published content. # @see http://scrivito.com/about-working-copies About working copies class Workspace extend ActiveModel::Naming include ModelIdentity PublishPreventedDueToContentChange = Class.new(ScrivitoError) # Set the workspace to use for subsequent workspace operations. # @api public # @param [Scrivito::Workspace] workspace def self.current=(workspace) @current = workspace end def self.current_using_proc=(workspace_proc) @current = workspace_proc end # Returns the currently used workspace. # @api public # @return [Scrivito::Workspace] def self.current if @current.respond_to? :call @current = @current.call else @current ||= published end end # Returns all workspaces. # @api public # @return [Array] def self.all result_json = CmsRestApi.get('/workspaces') result_json['results'].map do |raw_data| Workspace.new(WorkspaceData.new(raw_data)) end end def self.published find("published") end def self.published_with_fallback cached_workspace_data = CmsBackend.instance.find_workspace_data_from_cache('published') if cached_workspace_data workspace_data = begin CmsBackend.instance.find_workspace_data_by_id('published', 0.5) rescue => e warn_backend_not_available(e.message) cached_workspace_data end from_workspace_data('published', workspace_data) else published end end # Find a workspace by its id. # @api public # @param [String] id # @return [Scrivito::Workspace] # @raise [Scrivito::ResourceNotFound] def self.find(id) cache.fetch(id) do workspace_data = CmsBackend.instance.find_workspace_data_by_id(id) from_workspace_data(id, workspace_data) end end # Find a workspace by its title. # If multiple workspaces share the same title, one of them is returned. # If no workspace with the given title can be found, +nil+ is returned. # @api public # @param [String] title # @return [Scrivito::Workspace] def self.find_by_title(title) all.detect { |workspace| workspace.title == title } end # Find a workspace by its id or title and set it as the currently used workspace. # @example # Scrivito::Workspace.use('6a75fe694eeeb093') # # Scrivito::Workspace.current.id # # => '6a75fe694eeeb093' # # Scrivito::Workspace.use('my working copy') # # Scrivito::Workspace.current.title # # => 'my working copy' # # # raises Scrivito::ResourceNotFound: # Scrivito::Workspace.use('missing') # @api public # @param [String] id_or_title # @return [void] # @raise [Scrivito::ResourceNotFound] def self.use(id_or_title) workspace = begin find(id_or_title) rescue ResourceNotFound find_by_title(id_or_title) end if workspace.blank? raise(ResourceNotFound, "Could not find #{self} with id or title #{id_or_title}") end self.current = workspace end delegate :content_state_id, :base_content_state_id, :content_state, :base_revision_id, :base_content_state, to: :data # Create a new workspace. # @example Create a workspace, providing its title: # Scrivito::Workspace.create(title: "Jane") # @api public # @param [Hash] attributes # @return [Scrivito::Workspace] def self.create(attributes) workspace_json = CmsRestApi.post("/workspaces", workspace: attributes) self.find(workspace_json["id"]) end # Reloads the current workspace to reflect the changes that were made to it concurrently # since it was loaded. # @api public def self.reload current.reload end def self.cache @cache ||= {} end def initialize(workspace_data) update_data(workspace_data) @id = data.id end # Reloads this workspace to reflect the changes that were made to it concurrently since # it was loaded. # @api public def reload update_data(method(:fetch_workspace_data)) end def eager_reload update_data(fetch_workspace_data) end def api_request(verb, path, payload = nil) response = CmsRestApi.public_send(verb, "#{backend_url}#{path}", payload) reload if [:post, :put, :delete].include?(verb) response end def task_unaware_api_request(verb, path, payload = nil) CmsRestApi.task_unaware_request(verb, "#{backend_url}#{path}", payload) end # Updates the attributes of this workspace. # @api public # @param [Hash] attributes # @return [Scrivito::Workspace] def update(attributes) raise ScrivitoError, 'published workspace is not modifiable' if published? CmsRestApi.put(backend_url, workspace: attributes) reload end # Destroy this workspace. # @api public def destroy reset_workspace_if_current CmsRestApi.delete(backend_url) end # Publish the changes that were made to this workspace. # @api public def publish CmsRestApi.put("#{backend_url}/publish", {}) Workspace.published.reload reset_workspace_if_current end # Rebases the current workspace from the published content in order to integrate the changes # that were published in the meantime. # @api public def rebase CmsRestApi.put("#{backend_url}/rebase", {}) reload end # Returns the id of the workspace. # @api public # @return [String] def id @id end def revision_id data.revision_id end # Returns the title of the workspace if present. Otherwise, and for the published content, # an empty +String+ is returned. # @api public # @return [String] def title return '' if published? data.title || '' end # @api public # Returns the memberships (users and their roles) of this workspace. # @return [MembershipCollection] def memberships @memberships ||= MembershipCollection.new(self) end def data if @workspace_data.respond_to?(:call) @workspace_data = @workspace_data.call else @workspace_data end end def published? self.id == 'published' end def outdated? !published? && Workspace.published.revision.id != base_revision_id end def revision unless data.content_state_id? # reload data from changes feed in order to obtain content_state_id reload raise InternalError unless data.content_state_id? end @revision ||= Revision.new(id: revision_id, workspace: self) end def base_revision if base_revision_id @base_revision ||= Revision.new( id: base_revision_id, workspace: self, base: true ) end end def as_current(&block) old_workspace = Workspace.current begin Workspace.current = self yield ensure Workspace.current = old_workspace end end def assert_revertable raise ScrivitoError, 'published workspace is not modifiable' if published? end # Returns an {ObjCollection} of this working copy for accessing its CMS objects. # @api public # @return {ObjCollection} def objs @objs ||= ObjCollection.new(self) end def inspect "<#{self.class} id=\"#{id}\" title=\"#{title}\">" end def has_modification_for?(obj_id) !!objs.find_including_deleted(obj_id).modification rescue Scrivito::ResourceNotFound false end def self.all_with_modification_for(obj_id) all.select do |ws| ws.has_modification_for?(obj_id) end end def conflict_warning_for(obj_id) self.class.all_with_modification_for(obj_id) - [self] end private def update_data(new_data) @workspace_data = new_data # Clear all cached instance variables. @base_revision = nil @memberships = nil @revision = nil end def fetch_workspace_data CmsBackend.instance.find_workspace_data_by_id(id) end def backend_url "/workspaces/#{id}" end def reset_workspace_if_current Workspace.cache.delete(id) if Workspace.current == self Workspace.current = Workspace.published end end class << self private def from_workspace_data(id, data) unless data raise ResourceNotFound, "Could not find #{self} with id #{id}" end cache[id] = Workspace.new(data) end def warn_backend_not_available(error_message) message = <<-EOS Couldn't connect to backend to fetch published workspace. #{error_message} Serving from cache. EOS Rails.logger.warn(message) end end end end