scrivito_sdk 0.18.1 → 0.30.0.rc1

data/lib/scrivito/basic_widget.rb

@@ -25,7 +25,7 @@ class BasicWidget
   # The new Widget must be stored inside a container (i.e. an Obj or another Widget)
   # before it can be used.
   #
-  # See {BasicObj.create Obj.create} for a detailed overview of how to set attributes.
+  # See {Scrivito::BasicObj.create Obj.create} for a detailed overview of how to set attributes.
   # @api public
   # @param [Hash] attributes
   #
@@ -51,7 +51,7 @@ class BasicWidget
 
   # Update the attributes of this Widget
   #
-  # See {BasicObj.create Obj.create} for a detailed overview of how to set attributes
+  # See {Scrivito::BasicObj.create Obj.create} for a detailed overview of how to set attributes
   # @api public
   # @param [Hash] attributes
   def update(attributes)
@@ -59,16 +59,16 @@ class BasicWidget
     reload
   end
 
-  # Destroys the {BasicWidget Widget} in the current {Workspace}
+  # Destroys the {Scrivito::BasicWidget Widget} in the current {Workspace}
   # @api public
   def destroy
     new_widget_list = container[container_field_name] - [self]
     container.update(container_field_name => new_widget_list)
   end
 
-  # Clones the {BasicWidget Widget}. The clone gets all
+  # Clones the {Scrivito::BasicWidget Widget}. The clone gets all
   # attributes of the original widget except nested widget attributes.
-  # The clone is not attached to an {BasicObj Obj} initially.
+  # The clone is not attached to an {Scrivito::BasicObj Obj} initially.
   # It only becomes usable by assigning it to a widget attribute of an Obj.
   #
   # @example
@@ -107,10 +107,21 @@ class BasicWidget
     self == other
   end
 
-  # Reverts content changes of this widget. Widget attributes of this widget are not effected.
-  # After calling this method it's as if this widget has been never modified in the current working copy.
-  # This method does not work with +new+ or +deleted+ widgets.
-  # This method also does also not work for the +published+ workspace or the +rtc+ working copy.
+  #
+  # Reverts all changes made to the +Widget+ in the current workspace.
+  #
+  # @api public
+  #
+  # @note This method does not support +Widget+s, which are +new+.
+  #   Please use {Scrivito::BasicWidget#destroy Widget#destroy} to destroy them.
+  # @note This method does not support +Widget+s, which are +deleted+.
+  #   Please use {Scrivito::BasicObj#revert Obj#revert} to restore them.
+  #
+  # @raise [ScrivitoError] If the current workspace is +published+.
+  # @raise [ScrivitoError] If the current workspace is the +rtc+ workspace.
+  # @raise [ScrivitoError] If the +Widget+ is +new+.
+  # @raise [ScrivitoError] If the +Widget+ is +deleted+.
+  #
   def revert
     workspace.assert_revertable
 
@@ -170,7 +181,7 @@ class BasicWidget
     end
   end
 
-  # returns the entity ({BasicObj} or {BasicWidget}) that references this widget
+  # returns the entity ({Scrivito::BasicObj} or {Scrivito::BasicWidget}) that references this widget
   # @api public
   def container
     @container || cache_container_and_field_name_for_widget.first
@@ -182,6 +193,10 @@ class BasicWidget
     @container_field_name || cache_container_and_field_name_for_widget.second
   end
 
+  def has_attribute?(key)
+    key.to_s == '_obj_class' || super
+  end
+
   def inspect
     if @id
       if @obj

data/lib/scrivito/binary.rb

@@ -0,0 +1,75 @@
+module Scrivito
+
+# @api public
+# The Binary class represents the data stored in a binary attribute of an Obj
+# or Widget
+class Binary
+  def initialize(id, public_content)
+    @id = id
+    @public_content = public_content
+  end
+
+  # @api public
+  # Some Scrivito data is considered private, i.e. it is not currently intended
+  # for the general public, for example content in a workspace that has not 
+  # been published yet.
+  # @return [Boolean]
+  def private?
+    !public_content?
+  end
+
+  # @api public
+  # The URL where this binary data is accessible and can be downloaded using an
+  # HTTP GET request. Note that urls for private content will have an
+  # expiration time in order to protect them.
+  # Therefore the url returned here should be accessed immediately after it has been returned (i.e. within a couple of minutes).
+  # When accessed after they have expired, an error will occur.
+  # The urls should not be used for long-term-storage (i.e. they are no longer accessible hours or days after they have been generated).
+  # @return [String] the URL under which this content is available
+  def url
+    find_url('get')
+  end
+
+  # @api public
+  # the filename of this binary data, for example "my_image.jpg"
+  # @return [String] the filename of binary
+  def filename
+    File.basename(URI(url).path)
+  end
+
+  # @api public
+  # the content type of this binary data, for example "image/jpeg"
+  # @return [String] content type
+  def content_type
+    headers[:content_type]
+  end
+
+  # @api public
+  # the length of this binary data, in bytes.
+  # @return [Integer] number of bytes
+  def content_length
+    headers[:content_length].to_i
+  end
+
+  private
+
+  attr_reader :id
+
+  def public_content?
+    !!@public_content
+  end
+
+  def headers
+    CmsBackend.instance.find_blob_metadata(id, find_url('head'))
+  end
+
+  def find_url(verb)
+    CmsBackend.instance.find_blob_data(@id, access_type, verb)['url']
+  end
+
+  def access_type
+    public_content? ? 'public_access' : 'private_access'
+  end
+end
+
+end

data/lib/scrivito/cache_garbage_collector.rb

@@ -1,8 +1,12 @@
 module Scrivito
-  # The CacheGarbageCollector allows to remove old cache files from the Scrivito cache
-  # storage path. By default, a maximum of +DEFAULT_MAX_FILE_INODES+ file inodes that were accessed
-  # lately are kept in the cache directory. All other files and empty directories are removed. Log
-  # output is written to the Rails environment log file.
+  #
+  # The CacheGarbageCollector allows to remove old cache files from the Scrivito cache storage path.
+  # By default, a maximum of {Scrivito::CacheGarbageCollector::DEFAULT_MAX_FILE_INODES} file inodes
+  # that were accessed lately are kept in the cache directory.
+  # All other files and empty directories are removed.
+  # Log output is written to the Rails environment log file.
+  #
+  # @api public
   #
   # @example Running the garbage collector with default settings
   #
@@ -11,7 +15,13 @@ module Scrivito
   # @example Changing the maximum number of file inodes
   #
   #   bundle exec rake scrivito:cache:gc MAX_FILE_INODES=5000
+  #
   class CacheGarbageCollector
+    #
+    # Default maximum number of file inodes that are kept in the cache directory.
+    #
+    # @api public
+    #
     DEFAULT_MAX_FILE_INODES = 100000
 
     attr_accessor :max_file_inodes
@@ -20,6 +30,9 @@ module Scrivito
       @max_file_inodes = (max_file_inodes || DEFAULT_MAX_FILE_INODES).to_i
     end
 
+    #
+    # @api public
+    #
     def run_gc
       announce "Cap number of cache file inodes at #{max_file_inodes} in #{cache_path}."
 
@@ -58,6 +71,8 @@ module Scrivito
       announce "Done. Removed #{delta_count} entries. Saved at least #{delta_disk_space} Bytes."
     end
 
+    private
+
     def cache_path
       CmsCacheStorage.backend_cache.cache_path
     end

data/lib/scrivito/child_list_tag.rb

@@ -0,0 +1,108 @@
+module Scrivito
+
+class ChildListTag < Struct.new(:tag_name, :obj, :field_name, :view)
+  include TagRenderer
+
+  def initialize(tag_name, obj, field_name, view)
+    unless field_name == 'toclist'
+      raise "#{field_name} is not (yet) supported. Currently only toclist is supported."
+    end
+    super
+  end
+
+  def options
+    return {} unless user_present?
+
+    options = {
+      'private-child-list-allowed-classes' => Obj.valid_page_classes_beneath(obj.path).to_json,
+      'private-child-list-path'            => obj.path,
+      'private-obj-description-for-editor' => obj.description_for_editor,
+    }
+
+    if obj.has_attribute?(:child_order)
+      options['private-child-list-order-obj-id'] = obj.id
+      modification = comparison.modification_for_attribute(obj, :child_order)
+      if modification == Modification::EDITED
+        options['private-child-list-modification'] = modification
+      end
+    end
+
+    options
+  end
+
+  def content(&block)
+    return unless block_given?
+
+    is_sortable = obj.has_attribute?(:child_order) && user_present?
+    rendered_children = sorted_children.map do |child|
+      obj_tag = ObjTag.new(child, is_sortable, comparison.modification(child), view)
+      yield obj_tag, child
+      obj_tag.rendered
+    end
+    view.safe_join(rendered_children)
+  end
+
+  #
+  # This is a helper class for {ScrivitoHelper#scrivito_tag_list}.
+  # @api public
+  #
+  class ObjTag < Struct.new(:obj, :is_sortable, :modification, :view)
+    include TagRenderer
+
+    attr_reader :tag_name, :rendered
+
+    #
+    # @api public
+    #
+    # @param tag_name [String, Symbol] Name of the html tag (e.g. +:div+ or +:span+).
+    # @param html_options [Hash] Additional options, which are passed to +content_tag+.
+    #   Use them to add HTML attributes to the tag.
+    #
+    # @return [String] The rendered html tag
+    #
+    # @example Render a <div> tag containing the text "random content" and assigns the tag a css class called +very_important+.
+    #   <%= list.tag :div, class: "very_important" do %>
+    #     random content
+    #   <% end %>
+    #
+    def tag(tag_name, html_options = {}, &block)
+      raise '"list.tag" can only be called once per iteration!' if @rendered
+      @tag_name = tag_name
+      @rendered = render(html_options, &block)
+      nil
+    end
+
+    def options
+      return {} unless is_sortable
+      options = {
+        'private-obj-id'                     => obj.id,
+        'private-obj-description-for-editor' => obj.description_for_editor,
+      }
+      if modification == Modification::NEW || modification == Modification::DELETED
+        options['private-obj-modification'] = modification
+      end
+      options
+    end
+
+    def content(&block)
+      view.capture { yield } if block_given?
+    end
+  end
+
+  private
+
+  def user_present?
+    view.scrivito_user.present?
+  end
+
+  def comparison
+    EditingContextMiddleware.from_request(view.request).comparison
+  end
+
+  def sorted_children
+    children = obj.toclist
+    obj.has_attribute?(:child_order) ? Obj.sort_by_list(children, obj.child_order) : children
+  end
+end
+
+end

data/lib/scrivito/client_config.rb

@@ -24,7 +24,8 @@ class ClientConfig < Struct.new(:obj, :editing_context, :lookup_context, :resour
 
       selected_workspace: {
         id: selected_workspace.id,
-        title: selected_workspace.title
+        title: selected_workspace.title,
+        outdated: selected_workspace.outdated?
       },
 
       visible_workspace: {

data/lib/scrivito/client_error.rb

@@ -1,10 +1,11 @@
 module Scrivito
 
   class ClientError < StandardError
-    attr_reader :http_code
+    attr_reader :http_code, :error_code
 
-    def initialize(message, http_code)
+    def initialize(message, http_code, error_code=nil)
       @http_code = http_code
+      @error_code = error_code
       super(message)
     end
   end

data/lib/scrivito/cms_backend.rb

@@ -1,4 +1,4 @@
-require 'rest_client'
+require 'addressable/uri'
 
 module Scrivito
 
@@ -47,7 +47,6 @@ module Scrivito
   end
 
   class CmsBackend
-    BLOB_DATA_CACHE_PREFIX = 'blob_data'.freeze
     VALID_INDEX_NAMES = %w[id path ppath permalink].freeze
 
     class << self
@@ -77,6 +76,11 @@ module Scrivito
       @query_counter
     end
 
+    # For test purpose only.
+    def reset_query_counter!
+      @query_counter = 0
+    end
+
     def find_workspace_data_by_id(id)
       workspace_data_from_cache = WorkspaceDataFromService.find_from_cache(id)
       from_content_state_id = workspace_data_from_cache.try(:content_state_id)
@@ -110,16 +114,24 @@ module Scrivito
       find_obj_data_filtering_deleted_by(revision, index, keys, true)
     end
 
-    def find_blob_data_by_id(id)
-      cache_key = "#{BLOB_DATA_CACHE_PREFIX}/#{id}"
-      if data_from_cache = CmsCacheStorage.cache.read(cache_key)
-        data_from_cache
+    def find_blob_data(id, access, verb)
+      id = Addressable::URI.normalize_component(id, Addressable::URI::CharacterClasses::UNRESERVED)
+      if blob_data = fetch_blob_data_from_cache(id, access, verb)
+        blob_data
       else
-        data_from_database = find_blob_data_from_database_by(id)
-        if maxage = data_from_database['maxage']
-          CmsCacheStorage.cache.write(cache_key, data_from_database, :expires_in => maxage)
-        end
-        data_from_database
+        blob_datas = request_blob_datas_from_backend(id)
+        store_blob_datas_in_cache(id, blob_datas)
+        blob_datas[access][verb]
+      end
+    end
+
+    def find_blob_metadata(id, url)
+      if blob_metadata = fetch_blob_metadata_from_cache(id)
+        blob_metadata
+      else
+        blob_metadata = request_blob_metadata_from_s3(url)
+        store_blob_metadata_in_cache(id, blob_metadata)
+        blob_metadata
       end
     end
 
@@ -179,6 +191,64 @@ module Scrivito
       content_state.save_obj_data(cache_index, cache_key, result) if caching?
     end
 
+    def fetch_blob_data_from_cache(id, access, verb)
+      CmsCacheStorage.cache.read(blob_data_cache_key(id, access, verb))
+    end
+
+    def request_blob_datas_from_backend(id)
+      @query_counter += 1
+      CmsRestApi.get("blobs/#{id}")
+    end
+
+    def store_blob_datas_in_cache(id, blob_datas)
+      %w[public_access private_access].each do |access|
+        %w[get head].each do |verb|
+          blob_data = blob_datas[access][verb]
+          CmsCacheStorage.cache.write(blob_data_cache_key(id, access, verb),
+            blob_data, expires_in: blob_data['maxage'])
+        end
+      end
+    end
+
+    def blob_data_cache_key(id, access, verb)
+      "blob_data/#{id}/#{access}/#{verb}"
+    end
+
+    def fetch_blob_metadata_from_cache(id)
+      CmsCacheStorage.cache.read(blob_metadata_cache_key(id))
+    end
+
+    def request_blob_metadata_from_s3(url)
+      uri = URI.parse(url)
+      retried = false
+      begin
+        response = ConnectionManager.request(uri, Net::HTTP::Head.new(uri.path))
+        @query_counter += 1
+      rescue NetworkError
+        raise if retried
+        retried = true
+        retry
+      end
+
+      raise ScrivitoError, "S3 responded with #{reponse.code}" unless response.code == '200'
+
+      {
+        content_length: response['content-length'],
+        content_type:   response['content-type'],
+        cache_control:  response['cache-control'],
+      }
+    end
+
+    def store_blob_metadata_in_cache(id, blob_metadata)
+      max_age = blob_metadata.delete(:cache_control) =~ /max-age=(.*),/ && $1
+      max_age = max_age.to_i if max_age
+      CmsCacheStorage.cache.write(blob_metadata_cache_key(id), blob_metadata, expires_in: max_age)
+    end
+
+    def blob_metadata_cache_key(id)
+      "blob_metadata/#{Digest::SHA1.hexdigest(id)}" # id of a blob is a URI.
+    end
+
     def find_obj_data_filtering_deleted_by(revision, index, keys, include_deleted)
       index = index.to_s
       assert_valid_index_name(index)
@@ -269,11 +339,6 @@ module Scrivito
       ContentStateCaching.store_obj_data(revision.content_state, index, key, item)
     end
 
-    def find_blob_data_from_database_by(id)
-      @query_counter += 1
-      ContentService.query('blobs/query', :blob_ids => [id])['blobs'][id]
-    end
-
     def assert_valid_index_name(index)
       raise ArgumentError, "invalid index name '#{index}'" unless VALID_INDEX_NAMES.include?(index)
     end