module PIM::Services::ItemService

# File services.rb, line 3033
def __get_item primary_key, **named_arguments, &loader

  return nil if PIM.is_empty?(primary_key)

  # Restrict to valid load options and convert to 'camelized' keys
  load_options = named_arguments.map { |k,v| [PIM::Utils.camelize(k), v] }.filter { |k,v| GET_ITEM_LOAD_OPTIONS.include?(k) }.to_h

  # Get cache for type
  type = named_arguments[:type]
  data_module = PIM.active_module
  if data_module.has_option?(:enable_get_item_cache)

    # Use type dependent fiber-local cache
    item_cache = data_module.item_cache(type: type)

  else

    # Check if a cache argument was specified and actually is a LRUCache
    item_cache = named_arguments[:cache] || named_arguments[:item_cache]
    item_cache = nil unless item_cache.is_a?(PIM::LRUCache)

  end

  # Don't use cache if 'no_cache' option was specified
  item_cache = nil if (named_arguments[:no_cache] == true)

  # New option: "ensure_include_attributes"
  # - Will check the "cache" first to see if those attribute are available and then return that item
  # - Otherwise retrieve the item using "default_exclude: true, include_attributes: ensure_include_attributes"!

  # 'Pop' out ensure-include-attributes and check cache, if no other options were set
  ensure_include_attributes = load_options.delete('ensureIncludeAttributes')
  if not PIM::Utils.is_empty?(ensure_include_attributes) and PIM::Utils.is_empty?(load_options) and not item_cache.nil?

    item = item_cache[primary_key]

    # Item must exist and each 'ensureIncludeAttributes' must exist, i.e. must not be null
    # FIXME: This currently only works for JSON or JAVA formats!
    if not item.nil?

      if type == :json
        return item if ensure_include_attributes.all? { |a| item.include?(a.to_s) }
      elsif type == :java
        return item if ensure_include_attributes.all? { |a| !PIM::Utils.get_value(item, a.to_s).nil? }
      end
      item = nil

    end

    # Matching item was not found, so use the equivalent load-options
    load_options = { defaultExclude: true, includeAttributes: ensure_include_attributes }

  end

  # Only use cache if no load options were set
  load_options = nil if load_options.empty?
  item_cache = nil unless load_options.nil?

  # Check cache - unless 'reload' is specified
  if not named_arguments[:reload] and item_cache and item_cache.include?(primary_key)
    return item_cache[primary_key]
  end

  writingToCacheDisabled = item_cache.nil?

  # Don't write into cache if load_options contains one of NOCACHE_ITEM_LOAD_OPTIONS
  unless load_options.nil? || writingToCacheDisabled
    writingToCacheDisabled = !(load_options.keys.detect { |key| NOCACHE_ITEM_LOAD_OPTIONS.include?(key.to_s)}.nil?)
    PIM.log_info "Disabled writing to item_cache because load_options '#{load_options}' contains one of '#{NOCACHE_ITEM_LOAD_OPTIONS}'"
  end

  item = loader.call(load_options)

  item_cache[primary_key] = item unless writingToCacheDisabled

  return item
end

# File services.rb, line 3112
def __service_load_options load_options

  # Set attribute includes and excludes, if specified in data model option
  include_attributes = PIM.active_module.get_data_model_opt(:get_item_include_attributes, [])
  exclude_attributes = PIM.active_module.get_data_model_opt(:get_item_exclude_attributes, [])
  default_exclude = PIM.active_module.has_data_model_opt?(:get_item_default_exclude)

  unless include_attributes.empty? and exclude_attributes.empty? and !default_exclude
    load_options ||= {}
    load_options['includeAttributes'] =  PIM.stringified_value(include_attributes) unless include_attributes.empty?
    load_options['excludeAttributes'] =  PIM.stringified_value(exclude_attributes) unless exclude_attributes.empty?
    load_options['defaultExclude'] = default_exclude if default_exclude
  end

  load_options

end

# File services.rb, line 3134
def convert_item_to_json java_item
  __item_service.convertItemToJson(java_item)
end

# File services.rb, line 3141
def convert_item_to_xml java_item
  __item_service.convertItemToXml(java_item).to_io
end

# File services.rb, line 3148
def convert_items_to_xml java_items
  __item_service.convertItemsToXml(java_items).to_io
end

# File services.rb, line 3221
def delete_item_status_values primary_key, *keys
  keys = PIM.stringified_array(keys.compact)
  __item_service.deleteItemStatusValues(primary_key, *keys)
end

# File services.rb, line 2956
def get_item_as_java primary_key, **named_arguments
  __get_item(primary_key, **named_arguments, type: :java) do |load_options|

    java_item = __item_service.getItem(primary_key, __service_load_options(load_options))

    # Convert to "pseudo" Java item if Hash
    java_item =  __convert(java_item, to: Item)

    java_item

  end
end

# File services.rb, line 2975
def get_item_as_json primary_key, **named_arguments
  __get_item(primary_key, **named_arguments, type: :json) do |load_options|

    json_item = __item_service.getItemAsJson(primary_key, __service_load_options(load_options))

    # No conversion necessary
    json_item

  end
end

# File services.rb, line 2991
def get_item_as_ruby primary_key, **named_arguments
  __get_item(primary_key, **named_arguments, type: :ruby) do |load_options|

    json_item = get_item_as_json(primary_key, **(load_options || {}))

    # Convert to Ruby
    ruby_item = PIM::Item.from_json(json_item, load_options) if json_item

    ruby_item

  end
end

# File services.rb, line 3009
def get_item_as_xml primary_key, **named_arguments
  __get_item(primary_key, **named_arguments, type: :xml) do |load_options|

    xml_item = __item_service.getItemAsXml(primary_key, __service_load_options(load_options))

    # Return Ruby IO object from Java InputStream
    xml_item = xml_item.nil? ? nil : xml_item.to_io

    xml_item

  end
end

# File services.rb, line 3203
def get_item_attribute_histories primary_key, newest_first: true
  __item_service.loadAllItemAttributeHistories(primary_key, newest_first)
end

# File services.rb, line 3028
def get_item_event_history primary_key, newest_first:, event_type:
  __item_service.loadAllItemEvents(primary_key, newest_first, event_type)
end

# File services.rb, line 3235
def get_item_hierarchies root_primary_key
  __convert(__item_hierarchy_service.getItemHierarchies(root_primary_key), to: ItemHierarchy, array: true, force: true)
end

# File services.rb, line 3229
def get_item_hierarchy hierarchy_name, root_primary_key
  return __convert(__item_hierarchy_service.getItemHierarchy(hierarchy_name.to_s, root_primary_key), to: ItemHierarchy, force: true)
end

# File services.rb, line 3207
def get_item_status_value primary_key, key
  __item_service.getItemStatusValue(primary_key, key.to_s)
end

# File services.rb, line 3211
def get_item_status_values primary_key, *keys
  keys = PIM.stringified_array(keys.compact)
  __item_service.getItemStatusValues(primary_key, *keys)
end

# File services.rb, line 3324
def get_item_validation_results primary_key, language: nil
  validation_result = __item_service.getItemValidationResult(primary_key)
  PIM::Services.__convert(validation_result, to: ItemValidationResult)
end

# File services.rb, line 3275
def get_items_referenced_by_item_hierarchies *item_primary_keys, format: :json, hierarchy_names: nil, load_queried_items: false, cache: true, max_number_of_items: 20

  # Load items from service
  hierarchy_names = PIM::Utils.stringified_non_empty_set(hierarchy_names) unless hierarchy_names.nil?
  items = case PIM::Utils.to_sym(format)
    when :java then
      __convert(__item_service.getItemsReferencedByItemHierarchies(item_primary_keys, load_queried_items, max_number_of_items, *hierarchy_names), to: Item, array: true)
    when :json then
      __item_service.getItemsReferencedByItemHierarchiesAsJson(item_primary_keys, load_queried_items, max_number_of_items, *hierarchy_names)
    when nil then "Format must not be nil"
    else raise "Unknown format '#{format}'"
  end

  # Cache items, if necessary
  if cache and not PIM.is_empty?(items)
    data_module = PIM.active_module
    item_cache = data_module.item_cache(type: format)
    items.each do |item|
      primary_key = PIM::Utils.get_value(item, :primaryKey__)
      item_cache[primary_key] = item
    end
  end

  items

end

# File services.rb, line 3262
def get_primary_keys_referenced_by_item_hierarchies *item_primary_keys, hierarchy_names: nil
  hierarchy_names = PIM::Utils.stringified_non_empty_set(hierarchy_names) unless hierarchy_names.nil?
  __item_hierarchy_service.getPrimaryKeysReferencedByItemHierarchies(item_primary_keys, *hierarchy_names)
end

# File services.rb, line 3254
def get_referenced_item_hierarchies *item_primary_keys, hierarchy_names: nil
  hierarchy_names = PIM::Utils.stringified_non_empty_set(hierarchy_names) unless hierarchy_names.nil?
  __convert(__item_hierarchy_service.getReferencedItemHierarchies(item_primary_keys, *hierarchy_names), to: ItemHierarchy, array: true, force: true)
end

# File services.rb, line 3247
def has_any_item_hierarchy root_primary_key
  __item_hierarchy_service.hasAnyItemHierarchy(root_primary_key)
end

# File services.rb, line 3241
def has_item_hierarchy hierarchy_name, root_primary_key
  __item_hierarchy_service.hasItemHierarchy(hierarchy_name.to_s, root_primary_key)
end

# File services.rb, line 3307
def revalidate_items primary_keys = nil, query: nil, revalidate_attributes: nil, revalidate_rules: nil

  raise "Either 'primary_keys' or 'query' can be specified, but not both" unless primary_keys.nil? or query.nil?

  revalidate_attributes = PIM::Utils.stringified_non_empty_set(revalidate_attributes) unless revalidate_attributes.nil?
  revalidate_rules = PIM::Utils.stringified_non_empty_set(revalidate_rules) unless revalidate_rules.nil?

  if not primary_keys.nil?
    primary_keys = PIM::Utils.stringified_non_empty_set(primary_keys)
    __item_service.queueRevalidateItems(primary_keys, revalidate_attributes, revalidate_rules)
  elsif not query.nil?
    __item_service.queueRevalidateItems(query.to_s, revalidate_attributes, revalidate_rules)
  else
    __item_service.queueRevalidateAllItems(revalidate_attributes, revalidate_rules)
  end
end

# File services.rb, line 3164
def search_items keyword: nil, tag: nil, **opts

  query_params = {}
  query_params[:keyword] = keyword
  query_params[:tags] = tag
  query_params[:count] = opts[:count]
  query_params[:sort] = opts[:sort]
  query_params[:direction] = opts[:direction]
  query_params[:cursor] = opts[:cursor]
  query_params[:fields] = opts[:fields]
  query_params = PIM.stringified_value(query_params)

  search_result = __convert(__item_search_service.searchItems(query_params), to: ItemSearchResult)

  return search_result

end

# File services.rb, line 3216
def update_item_status_values primary_key, status_values
  status_values = PIM.stringified_hash(status_values)
  __item_service.updateItemStatusValues(primary_key, status_values)
end