scrivito_sdk 0.65.2 → 0.66.0.rc1

data/lib/scrivito/cms_data_cache.rb

@@ -27,17 +27,16 @@ module CmsDataCache
     end
 
     SCHEMA = {
-      workspace_data:     'workspace/#{workspace_id}',
-
       # CONTENT SERVICE
       content_state:      'content/#{content_state_id}',
       obj_data:           'content/#{content_state_id}/obj/#{index}/#{key}',
-      obj_classes_data:   'content/#{content_state_id}/obj_classes',
+      workspace_data:     'workspace/#{workspace_id}',
 
       # REST API
       obj_data_rest:      'obj/#{cache_id}/#{index}/#{key}',
       content_state_node: 'csn/#{content_state_id}',
-      workspace_csid:     'wscsid/#{workspace_id}'
+      workspace_state:    'wrkstt/#{workspace_id}',
+      tag_data:           'tagd/#{tag}'
     }
 
     SCHEMA.each do |name, schema|
@@ -59,6 +58,24 @@ module CmsDataCache
           cache.write("#{schema}", data)
         end
       END
+
+      # for test purposes
+      class_eval(<<-END, __FILE__, __LINE__ + 1)
+        def evict_#{name}(#{params_code})
+          cache.write("#{schema}", nil)
+        end
+      END
+    end
+
+    def write_data_to_tag(data)
+      tag = Digest::SHA1.base64digest(Marshal::dump(data))
+      write_tag_data(tag, data)
+
+      tag
+    end
+
+    def read_data_from_tag(tag)
+      read_tag_data(tag)
     end
 
     private

data/lib/scrivito/cms_dispatch_controller.rb

@@ -17,6 +17,11 @@ module Scrivito
         end
       end
 
+      if obj_not_found? && editing_context.workspace_changed?
+        redirect_to scrivito_path(Obj.homepage)
+        return self.response
+      end
+
       controller = target_controller(env)
       env["action_dispatch.request.path_parameters"]["controller"] = controller.controller_path
 
@@ -35,6 +40,14 @@ module Scrivito
       Rails.application.routes.url_helpers
     end
 
+    def scrivito_engine
+      Scrivito::SdkEngine.routes.url_helpers
+    end
+
+    def editing_context
+      EditingContextMiddleware.from_request(request)
+    end
+
     def target_controller(env)
       return default_controller if obj_not_found?
       controller = "#{loaded_obj.controller_name}Controller".constantize

data/lib/scrivito/cms_field_tag.rb

@@ -1,7 +1,7 @@
 module Scrivito
 
 # this class is the server-side equivalent of the JavaScript class `cms_field_element`
-class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :field_name, :widget_template_name)
+class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :editing_options)
   FIELD_TYPES_WITH_ORIGINAL_CONTENT = %w[
     binary
     date
@@ -11,7 +11,7 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :field_name, :w
     reference
     referencelist
     string
-    text
+    stringlist
   ]
 
   include TagRenderer
@@ -21,7 +21,7 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :field_name, :w
       raise ArgumentError, 'No block allowed for widgetlist fields' if block_given?
       modifications = modification_info || []
       rendered_widgets = default_content.each_with_index.map do |widget, index|
-        WidgetTag.new(view, widget, modifications[index], widget_template_name).render
+        WidgetTag.new(view, widget, modifications[index], widget_template_name, inner_tag).render
       end
       view.safe_join(rendered_widgets)
     else
@@ -59,6 +59,7 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :field_name, :w
     end
 
     if field_type == 'widgetlist'
+      options["private-field-widget-inner-tag"] = inner_tag
       options['private-field-widget-allowed-classes'] = build_valid_widget_classes.to_json
       options['private-field-widget-template'] = widget_template_name
     end
@@ -83,6 +84,18 @@ class CmsFieldTag < Struct.new(:view, :tag_name, :obj_or_widget, :field_name, :w
     end
   end
 
+  def widget_template_name
+    editing_options[:widget_template_name]
+  end
+
+  def field_name
+    editing_options[:field_name]
+  end
+
+  def inner_tag
+    editing_options[:inner_tag] || WidgetTag::DEFAULT_TAG
+  end
+
   def field_type
     @field_type ||= obj_or_widget.type_of_attribute(field_name)
   end

data/lib/scrivito/cms_rest_api.rb

@@ -18,11 +18,11 @@ module Scrivito
   #
   # @example Specify a poll interval (in seconds; default: 2) to use in case the response
   # is a task reference response and the final response is polled for:
-  #   Scrivito::CmsRestApi.put('workspace/rtc/publish', nil, :interval => 10)
+  #   Scrivito::CmsRestApi.put('workspace/001384beff9e5845/publish', nil, :interval => 10)
   #
   # @example Return immediately with the first response (without polling in case it is a
   # task reference response):
-  #   Scrivito::CmsRestApi.task_unaware_request(:put, 'workspace/rtc/publish', nil)
+  #   Scrivito::CmsRestApi.task_unaware_request(:put, 'workspace/001384beff9e5845/publish', nil)
   #
   class CmsRestApi
     METHOD_TO_NET_HTTP_CLASS = {

data/lib/scrivito/cms_routing.rb

@@ -1,6 +1,6 @@
 module Scrivito
 
-class CmsRouting < Struct.new(:request, :main_app)
+class CmsRouting < Struct.new(:request, :main_app, :scrivito_engine, :image_options)
   LINK_TO_EMPTY_LINKLIST = "#__empty_linklist"
   LINK_TO_EMPTY_BLOB = "#__empty_blob"
 
@@ -9,8 +9,8 @@ class CmsRouting < Struct.new(:request, :main_app)
   end
 
   def path_or_url(target, path_or_url, options = {})
-    if cms_with_editing_context?(target)
-      path_or_url_with_editing_context(target, path_or_url, options)
+    if needs_editing_context?(target)
+      path_or_url_needs_editing_context(target, path_or_url, options)
     else
       path_or_url_without_editing_context(target, path_or_url, options)
     end
@@ -31,7 +31,11 @@ class CmsRouting < Struct.new(:request, :main_app)
             end
           end
 
-          path_or_url(obj, "path", options)
+          if editing_context.display_mode == 'editing'
+            id_path_or_url_for_objs(obj, :path, options)
+          else
+            path_or_url(obj, :path, options)
+          end
         else
           "#__target_object_not_reachable"
         end
@@ -41,9 +45,9 @@ class CmsRouting < Struct.new(:request, :main_app)
 
   private
 
-  def path_or_url_with_editing_context(target, path_or_url, options)
+  def path_or_url_needs_editing_context(target, path_or_url, options)
     path_or_url_without_editing_context(target, path_or_url,
-        options.merge(editing_context.to_params))
+      options.merge(editing_context.to_params))
   end
 
   def path_or_url_without_editing_context(target, path_or_url, options)
@@ -58,33 +62,30 @@ class CmsRouting < Struct.new(:request, :main_app)
         return LINK_TO_EMPTY_LINKLIST
       end
     elsif target.is_a?(Binary)
-      target.url
+      binary_url(target, path_or_url)
     else
       raise "scrivito_path or scrivito_url was called with an instance of #{target.class}. "+
         "It must only be called with an Obj or a Link or a non-empty LinkList."
     end
   end
 
-  def path_or_url_for_links(link, path_or_url, options = {})
+  def path_or_url_for_links(link, path_or_url, options)
     url = basic_url_or_path_for_link(link, path_or_url,
-        Rack::Utils.parse_nested_query(link.query).merge(options))
+      Rack::Utils.parse_nested_query(link.query).merge(options))
     url = url + "##{link.fragment}" if link.fragment.present?
     url
   end
 
-  def path_or_url_for_objs(obj, path_or_url, options = {})
-    if editing_context.display_mode == "editing"
-      return id_path_or_url_for_objs(obj, path_or_url, options)
-    end
-
+  def path_or_url_for_objs(obj, path_or_url, options)
     permalink = obj.permalink
     if permalink
-      main_app.public_send("scrivito_permalink_#{path_or_url}", options.merge(:permalink => permalink))
+      main_app
+        .public_send("scrivito_permalink_#{path_or_url}", options.merge(:permalink => permalink))
     elsif obj.homepage?
       main_app.public_send("scrivito_root_#{path_or_url}", options)
     elsif obj.binary?
-      if obj.binary_url
-        obj.binary_url
+      if binary = obj.binary
+        binary_url(binary, path_or_url)
       else
         LINK_TO_EMPTY_BLOB
       end
@@ -112,7 +113,7 @@ class CmsRouting < Struct.new(:request, :main_app)
     EditingContextMiddleware.from_request(request)
   end
 
-  def cms_with_editing_context?(target)
+  def needs_editing_context?(target)
     editor_authenticated? && (!target.is_a?(Link) || target.internal?)
   end
 
@@ -139,6 +140,28 @@ class CmsRouting < Struct.new(:request, :main_app)
   def extract_query(uri)
     Rack::Utils.parse_query(uri.query)
   end
+
+  def binary_url(binary, path_or_url)
+    binary = transform_binary(binary)
+    if url_from_cache = binary.url_from_cache
+      BinaryRewrite.call(request, url_from_cache)
+    else
+      encrypted_params = BinaryParamVerifier.generate(binary)
+      scrivito_engine.public_send("binary_#{path_or_url}", encrypted_params: encrypted_params)
+    end
+  end
+
+  def transform_binary(binary)
+    if transformation_definition = image_options[:transform]
+      binary.transform(transformation_definition)
+    else
+      binary
+    end
+  end
+
+  def image_options
+    super || {}
+  end
 end
 
 end

data/lib/scrivito/configuration.rb

@@ -207,6 +207,7 @@ module Scrivito
         self.endpoint = 'api.scrivito.com'
         self.check_batch_size = 100
         self.legacy_routing = false
+        self.default_image_transformation = {}
       end
 
       #
@@ -234,6 +235,27 @@ module Scrivito
 
       attr_accessor :choose_homepage_callback, :check_batch_size
 
+      #
+      # Set the default {Scrivito::Binary#transform image transformation}.
+      #
+      # @api beta
+      #
+      # When delivering binary Objs, the default image transformation will be applied if
+      # {Scrivito::BasicObj#apply_image_transformation? Obj#apply_image_transformation?} returns
+      # +true+.
+      #
+      # If not changed the default image transformation is an empty transformation (an empty +Hash+).
+      # Set it to +false+ to disabled the default image transformation completely.
+      #
+      # @param [Hash] value the {Scrivito::Binary#transform transformation definition}
+      #
+      # @see Scrivito::Binary#transform
+      # @see Scrivito::BasicObj#apply_image_transformation?
+      #
+      attr_writer :default_image_transformation
+
+      attr_reader :default_image_transformation
+
       # Configure a callback to be invoked when the Scrivito SDK delivers the homepage.
       # The given callback will receive the rack env
       # and must return an {BasicObj Obj} to be used as the homepage.

data/lib/scrivito/content_state.rb

@@ -48,14 +48,6 @@ class ContentState < Struct.new(:content_state_id, :changes, :changes_index, :fr
     CmsDataCache.read_obj_data(content_state_id, index, key)
   end
 
-  def save_obj_classes_data(data)
-    CmsDataCache.write_obj_classes_data(content_state_id, data)
-  end
-
-  def find_obj_classes_data
-    CmsDataCache.read_obj_classes_data(content_state_id)
-  end
-
   # Fetches and caches the ancestor.
   # Returns nil if there is no ancestor.
   def from_content_state
@@ -82,7 +74,7 @@ class ContentState < Struct.new(:content_state_id, :changes, :changes_index, :fr
         id_index.add(hash['id'])
         if path = hash['modified_path']
           path_index.add(path)
-          ppath_index.add(path.gsub(/\/[^\/]+$/, '').presence || '/') if path != '/'
+          ppath_index.add(ParentPath.of(path)) if path != '/'
         end
       end
     end

data/lib/scrivito/content_state_caching.rb

@@ -38,26 +38,6 @@ module ContentStateCaching
         nil
       end
     end
-
-    def store_obj_classes_data(content_state, data)
-      content_state.save_obj_classes_data(data)
-    end
-
-    def find_obj_classes_data(current_content_state)
-      visitor = ContentStateVisitor.new(current_content_state)
-
-      cache_lookup_depth.times do |depth|
-        return unless content_state = visitor.visit_next
-        if obj_classes_data = content_state.find_obj_classes_data
-          if depth >= cache_replication_depth
-            current_content_state.save_obj_classes_data(obj_classes_data)
-          end
-          return obj_classes_data
-        end
-      end
-
-      nil
-    end
   end
 
   self.cache_replication_depth = 5

data/lib/scrivito/controller_actions.rb

@@ -39,7 +39,8 @@ module ControllerActions
 
   def show_widget
     widget = load_widget
-    widget_tag = Scrivito::WidgetTag.new(view_context, widget, nil, params[:template_name])
+    widget_tag = Scrivito::WidgetTag.new(view_context, widget, nil,
+                                         params[:template_name], params[:inner_tag])
     render text: widget_tag.render, layout: false
   end
 
@@ -71,7 +72,7 @@ module ControllerActions
     # This method indicates if this controller should be used automatically when an +Obj+ is
     # requested via the SDK's standard routes. It returns +true+ by default.
     #
-    # Overwrite it to return +false+ if you do want your controller to be excluded from +Obj+
+    # Override it to return +false+ if you do want your controller to be excluded from +Obj+
     # dispatching.
     #
     # @api public

data/lib/scrivito/controller_runtime.rb

@@ -7,28 +7,36 @@ module ControllerRuntime
 
 protected
 
-  attr_internal :rc_runtime
+  attr_internal :scrivito_runtime
 
   def cleanup_view_runtime
-    rc_rt_before_render = Scrivito::LogSubscriber.reset_runtime
+    self.scrivito_runtime = reset_scrivito_runtime
+
     runtime = super
-    rc_rt_after_render = Scrivito::LogSubscriber.reset_runtime
-    self.rc_runtime = rc_rt_before_render + rc_rt_after_render
-    runtime - rc_rt_after_render
+
+    scrivito_rt_after_render = reset_scrivito_runtime
+    self.scrivito_runtime += scrivito_rt_after_render
+
+    runtime - scrivito_rt_after_render
   end
 
   def append_info_to_payload(payload)
     super
-    payload[:rc_runtime] = rc_runtime
+    payload[:scrivito_runtime] =
+        (self.scrivito_runtime || 0) + reset_scrivito_runtime
   end
 
   module ClassMethods
     def log_process_action(payload)
-      messages, rc_runtime = super, payload[:rc_runtime]
-      messages << ("Scrivito: %.1fms" % rc_runtime.to_f)
+      messages, scrivito_runtime = super, payload[:scrivito_runtime]
+      messages << ("Scrivito: %.1fms" % scrivito_runtime.to_f)
       messages
     end
   end
+
+  def reset_scrivito_runtime
+    Scrivito::LogSubscriber.reset_runtime
+  end
 end
 
 end # module Scrivito

data/lib/scrivito/dialog_size_helper.rb

@@ -0,0 +1,11 @@
+module Scrivito
+
+class DialogSizeHelper
+  def self.render_dialog_with_size(view, size, &block)
+    view.content_tag(:div, 'data-scrivito-modal-size' => size) do
+      view.capture { yield }
+    end
+  end
+end
+
+end

data/lib/scrivito/diff.rb

@@ -11,8 +11,6 @@ class Diff; class << self
       ListComparison.for(mode, old || [], new || [])
     when "html"
       for_html(mode, old, new)
-    when "text"
-      for_string(mode, old, new)
     when "string"
       for_string(mode, old, new)
     end

data/lib/scrivito/editing_context.rb

@@ -5,11 +5,13 @@ class EditingContext
   #   +:selected_workspace_id+: The id of the selected workspace. If empty +published+ workspace is used.
   #   +:display_mode+: Can be +view+, +editing+, +added+ or +deleted+. If empty +view+ is used.
   #   +:editor+: A block, which is lazy evaluated on first access, to determine the editor (details see {Scrivito::Configuration.editing_auth})
+  #   +:workspace_changed+: A boolean, determining if the workspace has been changed with this request.
   # @param [Hash] options
   def initialize(options = {})
     @selected_workspace_id = options[:selected_workspace_id]
     @display_mode = options[:display_mode] || "view"
     @editor_callback = options[:editor] || proc { false }
+    @workspace_changed = !!options[:workspace_changed]
   end
 
   def editor
@@ -34,6 +36,10 @@ class EditingContext
     editor.present?
   end
 
+  def workspace_changed?
+    @workspace_changed
+  end
+
   # @return [String]
   def display_mode
     if authenticated_editor? && !selected_workspace.published?
@@ -80,31 +86,36 @@ class EditingContext
 
   def find_selected_workspace
     if @selected_workspace_id
-      begin
-        workspace = Workspace.find(@selected_workspace_id)
-        if editor && editor.can?(:read, workspace)
-          workspace
-        else
-          default_workspace
+      workspace =
+        begin
+          Workspace.find(@selected_workspace_id)
+        rescue
+          Rails.logger.info "Workspace with ID #{@selected_workspace_id} is " +
+            "not available, using 'published' instead."
+
+          published_workspace
         end
-      rescue Scrivito::ResourceNotFound
-        default_workspace
+
+      if editor && editor.can?(:read, workspace)
+        workspace
+      else
+        published_workspace
       end
     else
-      default_workspace
+      published_workspace
     end
   end
 
   def find_visible_workspace
     if authenticated_editor?
-      display_mode == 'deleted' ? default_workspace : selected_workspace
+      display_mode == 'deleted' ? published_workspace : selected_workspace
     else
-      default_workspace
+      published_workspace
     end
   end
 
-  def default_workspace
-    Workspace.default
+  def published_workspace
+    Workspace.published
   end
 
   # @return [Revision] or +nil+