scrivito_sdk 0.60.0 → 0.65.0.rc1

data/lib/scrivito/controller_actions.rb

@@ -39,19 +39,24 @@ module ControllerActions
 
   def show_widget
     widget = load_widget
-    render text: Scrivito::WidgetTag.new(view_context, widget).render, layout: false
+    widget_tag = Scrivito::WidgetTag.new(view_context, widget, nil, params[:template_name])
+    render text: widget_tag.render, layout: false
   end
 
   def widget_details
     assert_dialog_layout
     widget = load_widget
     template_path = "#{widget.obj_class_name.underscore}/details"
+    @scrivito_default_widget_template = :details
     render template_path, layout: 'scrivito_dialog', locals: {widget: widget}
   end
 
   def page_details
     assert_dialog_layout
+    @scrivito_default_widget_template = :details
     render @obj.details_view_path, layout: 'scrivito_dialog'
+  rescue ActionView::MissingTemplate
+    render 'scrivito/page_details', layout: 'scrivito_dialog'
   end
 
   def resource_details

data/lib/scrivito/errors.rb

@@ -12,4 +12,9 @@ end
 class ObjClassNotFound < ResourceNotFound
 end
 
+# this error is raised if scrivito detects an internal problem.
+# these errors should never occur when using the public api of the SDK.
+class InternalError < ScrivitoError
+end
+
 end # module Scrivito

data/lib/scrivito/migrations/cms_backend.rb

@@ -16,6 +16,7 @@ module Scrivito
           CmsRestApi.put(endpoint("objs/#{migration_store_obj.id}"),
             obj: {versions: ['string', value]})
         end
+        Workspace.current.reload
       end
 
       private
@@ -28,6 +29,7 @@ module Scrivito
           CmsRestApi.post(endpoint('objs'),
             obj: {_path: path, _obj_class: 'MigrationStore', versions: ['string', '']})
         end
+        Workspace.current.reload
       end
 
       def migration_store_obj

data/lib/scrivito/named_link.rb

@@ -9,28 +9,6 @@ module Scrivito
     class NotFound < StandardError
     end
 
-    @@named_links_cache = nil
-
-    # Generates a cache of named links based on the CMS objects related link list.
-    # Raises exceptions if zero or more than one objects have this obj_class
-    def self.generate_named_links_cache
-      return if @@named_links_cache
-
-      found_object = find_named_link_obj
-      if found_object.nil?
-        raise NotFound, "Couldn't find NamedLink CMS Object!"
-      else
-        @@named_links_cache = found_object.
-          related_links.
-          flatten(1).
-          each_with_object({}) do |link_obj, temp|
-            temp[link_obj.title] = link_obj.obj
-          end
-      end
-
-      return nil
-    end
-
     # This method will be called to retrieve the NamedLink {BasicObj Obj}.
     # By default it will look for the Obj at the path "_named_links".
     # Overwrite this method only if you know what you are doing.
@@ -39,37 +17,23 @@ module Scrivito
       BasicObj.find_by_path("/_named_links")
     end
 
-    def self.cache_expiry_time=(value)
-      raise "NamedLink.cache_expiry_time is deprecated. NamedLink no longer has a separate cache."
-    end
-
-    def self.cache_expired?
-      true
-    end
-
     # Returns the CMS object mapped to the given title or nil.
     # The title can be a string of symbol.
     # @api public
     def self.get_object(title, options = {})
-      object = named_links[title.to_s]
-      raise NotFound, "The NamedLink '#{title.to_s}' does not exist" if object.nil?
-      object
-    end
-
-    def self.reset_cache
-      @@named_links_cache = nil
+      link = named_links.find { |link| link.title == title.to_s }
+      raise NotFound, "The NamedLink '#{title.to_s}' does not exist" unless link
+      link.obj
     end
 
     def self.named_links
-      reset_cache if cache_expired?
-      generate_named_links_cache unless named_links_cache
-      named_links_cache
-    end
+      named_link_obj = find_named_link_obj
 
-    def self.named_links_cache
-      @@named_links_cache
+      if named_link_obj
+        named_link_obj.related_links
+      else
+        raise NotFound, "Couldn't find NamedLink CMS Object!"
+      end
     end
-
   end
-
 end

data/lib/scrivito/obj_collection.rb

@@ -15,7 +15,7 @@ module Scrivito
     # @return [Obj, Array<Obj>]
     # @api public
     def find(id_or_list)
-      find_filtering_deleted(id_or_list, false)
+      find_using(id_or_list, :find_by)
     end
 
     # Find a {BasicObj Obj} by its id.
@@ -25,7 +25,7 @@ module Scrivito
     # @return [Obj, Array<Obj>]
     # @api public
     def find_including_deleted(id_or_list)
-      find_filtering_deleted(id_or_list, true)
+      find_using(id_or_list, :find_by_including_deleted)
     end
 
     # Find the {BasicObj Obj} with the given path.
@@ -98,28 +98,27 @@ module Scrivito
 
     private
 
-    def find_filtering_deleted(id_or_list, include_deleted)
+    def find_using(id_or_list, method)
       case id_or_list
       when Array
-        find_by(:id, id_or_list, include_deleted).map(&:first).compact
+        send(method, :id, id_or_list).map(&:first).compact
       else
-        obj = find_by(:id, [id_or_list.to_s], include_deleted).first.first
+        obj = send(method, :id, [id_or_list.to_s]).first.first
+
         obj or raise ResourceNotFound, "Could not find Obj with id #{id_or_list}"
       end
     end
 
-    # accepts the name of an "obj_by" - view, a list of keys
-    # and an "include_deleted" flag
-    # returns a list of lists of Objs: a list of Objs for each given keys.
-    def find_by(view, keys, include_deleted = false)
-      if include_deleted
-        finder_method_name = :find_obj_data_including_deleted_by
-      else
-        finder_method_name = :find_obj_data_by
+    def find_by(view, keys)
+      find_by_including_deleted(view, keys).map do |list|
+        list.reject(&:deleted?)
       end
+    end
 
-      result = CmsBackend.instance.public_send(
-        finder_method_name,
+    # accepts the name of an "obj_by" - view, a list of keys
+    # returns a list of lists of Objs: a list of Objs for each given keys.
+    def find_by_including_deleted(view, keys)
+      result = CmsBackend.instance.find_obj_data_by(
         workspace.revision,
         view,
         keys)

data/lib/scrivito/obj_create_params_parser.rb

@@ -1,13 +1,11 @@
 module Scrivito
-  class ObjCreateParamsParser < Struct.new(:host, :port)
-    include ObjParamsParser
-
+  class ObjCreateParamsParser < ObjParamsParser
     private
 
     def convert_params(params)
       if obj_class_name = params['_obj_class']
-        model_class = Obj.type_computer.compute_type(obj_class_name)
-        convert_field_params(params, model_class.attribute_definitions)
+        obj_class = Obj.type_computer.compute_type_without_fallback(obj_class_name)
+        convert_field_params(params, obj_class.attribute_definitions)
       else
         raise ArgumentError, 'Missing "_obj_class" param'
       end

data/lib/scrivito/obj_params_parser.rb

@@ -1,5 +1,5 @@
 module Scrivito
-  module ObjParamsParser
+  class ObjParamsParser < Struct.new(:host, :port, :context)
     class UnknownWidgetAction < ScrivitoError
     end
 
@@ -30,7 +30,7 @@ module Scrivito
         if widget_id_or_params.is_a?(Hash)
           action, widget_params = widget_id_or_params.flatten
           case action
-          when 'create' then Widget.new(widget_params)
+          when 'create' then Widget.new(widget_params, context.slice(:scrivito_user))
           when 'copy'
             widget_id = widget_params['widget_id']
             widget = Workspace.find(widget_params['workspace_id'])

data/lib/scrivito/obj_update_params_parser.rb

@@ -1,9 +1,11 @@
 module Scrivito
-  class ObjUpdateParamsParser < Struct.new(:obj, :host, :port)
-    include ObjParamsParser
-
+  class ObjUpdateParamsParser < ObjParamsParser
     private
 
+    def obj
+      context[:current_obj]
+    end
+
     def convert_params(params)
       convert_field_params(params, obj.attribute_definitions)
       convert_widget_pool_params(params)

data/lib/scrivito/revision.rb

@@ -1,13 +1,73 @@
 module Scrivito
 
-class Revision < Struct.new(:id, :content_state, :workspace, :base)
+class Revision < Struct.new(:id, :workspace, :base)
   def initialize(options)
-    super(*options.values_at(:id, :content_state, :workspace, :base))
+    super(*options.values_at(:id, :workspace, :base))
+  end
+
+  def content_state
+    base ? workspace.base_content_state : workspace.content_state
+  end
+
+  def content_state_id
+    base ? workspace.base_content_state_id : workspace.content_state_id
+  end
+
+  def content_state_node
+    @node ||= Backend::ContentStateNode.new(content_state_id)
+  end
+
+  # returns a list of raw rest-api hashes, one for each given id
+  def obj_mget_request(ids)
+    internal_obj_mget(ids, [])
+  end
+
+  # performs given search-query, returns the search-hits as a list of obj-ids
+  def obj_search_request(query)
+    if base
+      raise Scrivito::InternalError, "search not possible for base revision"
+    end
+
+    internal_obj_search(query, [])
+  end
+
+  def api_request(verb, path, payload = nil)
+    CmsRestApi.public_send(verb, "revisions/#{id}#{path}", payload)
   end
 
   def base?
     !!base
   end
+
+  private
+
+  def internal_obj_search(query, result)
+    response = workspace.api_request(:get, "/objs/search", {
+      query: query, include_deleted: true, size: 100, offset: result.size
+    })
+
+    cur_result = response['results'].map { |obj_data| obj_data['id'] }
+    result += cur_result
+
+    if result.size >= response['total'].to_i
+      result
+    else
+      internal_obj_search(query, result)
+    end
+  end
+
+  def internal_obj_mget(ids, result)
+    response = api_request(
+        :get, "/objs/mget", ids: ids, include_deleted: true)
+
+    current_result = result + response["results"]
+
+    if response["results"].size < ids.size
+      internal_obj_mget(ids.drop(response["results"].size), current_result)
+    else
+      current_result
+    end
+  end
 end
 
 end

data/lib/scrivito/type_computer.rb

@@ -6,11 +6,15 @@ class TypeComputer
   end
 
   def compute_type(obj_class_name)
-    compute_type_without_fallback(obj_class_name) || @fallback_class
+   load_class(obj_class_name) || @fallback_class
   end
 
   def compute_type_without_fallback(obj_class_name)
-    load_class(obj_class_name)
+    if obj_class = load_class(obj_class_name)
+      obj_class
+    else
+      raise ObjClassNotFound
+    end
   end
 
   def special_class?(klass)

data/lib/scrivito/widget_tag.rb

@@ -1,6 +1,6 @@
 module Scrivito
 
-class WidgetTag < Struct.new(:view, :widget, :placement_modification)
+class WidgetTag < Struct.new(:view, :widget, :placement_modification, :template_name)
   include TagRenderer
 
   def tag_name
@@ -8,7 +8,7 @@ class WidgetTag < Struct.new(:view, :widget, :placement_modification)
   end
 
   def content
-    view.render(template: template, locals: {widget: widget})
+    view.render(template: template_path, locals: {widget: widget})
   rescue ActionView::MissingTemplate
     %{Missing Ruby model class for "#{widget.obj_class_name}"} if view.scrivito_user
   end
@@ -46,8 +46,8 @@ class WidgetTag < Struct.new(:view, :widget, :placement_modification)
 
   private
 
-  def template
-    widget.to_show_view_path
+  def template_path
+    widget.public_send("to_#{template_name}_view_path")
   end
 
   def has_widget_details_view?(widget)

data/lib/scrivito/workspace.rb

@@ -79,7 +79,8 @@ class Workspace
     all.detect { |workspace| workspace.title == title }
   end
 
-  delegate :content_state, :base_revision_id, :base_content_state, :uses_obj_classes, to: :data
+  delegate :content_state_id, :base_content_state_id, :content_state,
+    :base_revision_id, :base_content_state, :uses_obj_classes, to: :data
 
   # Create a new workspace
   # @api public
@@ -203,14 +204,13 @@ class Workspace
   end
 
   def revision
-    @revision ||= Revision.new(id: revision_id, content_state: content_state, workspace: self)
+    @revision ||= Revision.new(id: revision_id, workspace: self)
   end
 
   def base_revision
     if base_revision_id
       @base_revision ||= Revision.new(
         id: base_revision_id,
-        content_state: base_content_state,
         workspace: self,
         base: true
       )
@@ -258,6 +258,22 @@ class Workspace
     "<#{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 backend_url

data/lib/scrivito/workspace_data.rb

@@ -11,9 +11,32 @@ module Scrivito
     data_attr_reader :id
     data_attr_reader :title
     data_attr_reader :memberships
+    data_attr_reader :revision_id
+    data_attr_reader :content_state_id
+    data_attr_reader :uses_obj_classes
+    data_attr_reader :base_revision_id
+    data_attr_reader :base_content_state_id
 
     def initialize(data)
       @data = data
     end
+
+    def store_in_cache
+      CmsDataCache.write_workspace_data(id, to_hash)
+    end
+
+    private
+
+    def to_hash
+      {
+        'id'                    => id,
+        'revision_id'           => revision_id,
+        'title'                 => title,
+        'content_state_id'      => content_state_id,
+        'base_revision_id'      => base_revision_id,
+        'base_content_state_id' => base_content_state_id,
+        'memberships'           => memberships,
+      }
+    end
   end
 end

data/lib/scrivito/workspace_data_from_service.rb

@@ -11,22 +11,7 @@ class WorkspaceDataFromService < WorkspaceData
     end
   end
 
-  data_attr_reader :revision_id
-  data_attr_reader :content_state_id
-  data_attr_reader :base_revision_id
-  data_attr_reader :base_content_state_id
   data_attr_reader :diff
-  data_attr_reader :uses_obj_classes
-
-  def content_state
-    @content_state ||= ContentState.find_or_create(content_state_id) if content_state_id
-  end
-
-  def base_content_state
-    if base_content_state_id
-      @base_content_state ||= ContentState.find_or_create(base_content_state_id)
-    end
-  end
 
   def changes
     diff && diff['changes']
@@ -42,25 +27,23 @@ class WorkspaceDataFromService < WorkspaceData
 
   # Serializes and stores a workspace data in cache storage.
   # Also creates an appropriate content state if needed.
-  def store_in_cache
+  def store_in_cache_and_create_content_state
     create_content_state if content_state_id
-    CmsDataCache.write_workspace_data(id, to_hash)
+    store_in_cache
   end
 
-  private
+  def content_state
+    @content_state ||= ContentState.find_or_create(content_state_id) if content_state_id
+  end
 
-  def to_hash
-    {
-      'id'                    => id,
-      'revision_id'           => revision_id,
-      'title'                 => title,
-      'content_state_id'      => content_state_id,
-      'base_revision_id'      => base_revision_id,
-      'base_content_state_id' => base_content_state_id,
-      'memberships'           => memberships,
-    }
+  def base_content_state
+    if base_content_state_id
+      @base_content_state ||= ContentState.find_or_create(base_content_state_id)
+    end
   end
 
+  private
+
   def create_content_state
     ContentState.create(content_state_id: to_content_state_id, changes: changes,
         from_content_state_id: from_content_state_id)