#--
# Copyright (c) 2012+ Damjan Rems
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
#++

#########################################################################
# == Schema information
#
# Collection name: dc_menu : Menus
#
#  _id                  BSON::ObjectId       _id
#  created_at           Time                 created_at
#  updated_at           Time                 updated_at
#  name                 String               Menu name
#  description          String               Short description of menu
#  div_name             String               Div id name around menu area
#  link_prepend         String               Link field usually holds direct link to document. Prepand field holds data, that has to be prepanded to the link.
#  css                  String               CSS for this menu
#  active               Mongoid::Boolean     Active
#  created_by           BSON::ObjectId       created_by
#  updated_by           BSON::ObjectId       updated_by
#  dc_menu_items        Embedded:DcMenuItem  Menu items
# 
# Default menu system for DRG CMS. Model recursively embeds DcMenuItem documents
# which (theoretically) results in infinite level of sub menus. In practice 
# reasonable maximum level of 4 is advised.
#########################################################################
class DcMenu
  include Mongoid::Document
  include Mongoid::Timestamps

  field :name,        type: String
  field :description, type: String
  field :div_name,    type: String
  field :link_prepend, type: String
  field :css,         type: String
  field :active,      type: Boolean, default: true 
  field :created_by,  type: BSON::ObjectId
  field :updated_by,  type: BSON::ObjectId

  belongs_to :dc_site
  embeds_many :dc_menu_items
  
  index( { name: 1 }, { unique: true } )

  validates :name, :length => { :minimum => 4 }
  validates :name, uniqueness: true  
  validates_length_of :description, minimum: 10
  
#######################################################################
# Will return all top level menu items of specified menu. Used in DcPage document for
# selecting top level selected menu, when document displayed in browser.
# 
# Called from DcApplicationHelper :dc_choices4_menu: method.
# 
# Parameters: 
# [Site] DcSite document. Site for which menu belongs to. If site is not specified 
# all current menus in dc_menus collection will be returned.
# 
# Returns:
# Array. Of choices prepared for select input field.
#######################################################################
def self.choices4_menu(site)
  rez = []
  menus = (site.menu_name.blank? ? all : where(name: site.menu_name)).to_a
  menus.each do |menu|
    rez << [menu.name, nil]
    menu.dc_menu_items.where(active: true).order_by(order: 1).each do |menu_item|
      rez << ['-- ' + menu_item.caption, menu_item._id]
    end
  end
  rez
end
  
#######################################################################
# Subroutine of choices4_menu_as_tree
#######################################################################
def self.do_sub_menu(menus, parent, ids) #:nodoc:
  result = []
  menus.each do |item|
    long_id = "#{ids};#{item.id}"
    result << [item.caption, long_id, parent, item.order]
    sub_menus = item.dc_menu_items.order_by(order: 1).to_a
    result += do_sub_menu(sub_menus, long_id, long_id) if sub_menus.size > 0
  end
  result
end

#######################################################################
# Will return menu structure for menus belonging to the site.
# 
# Parameters: 
# [Site] DcSite document. Site for which menu belongs to. If site is not specified 
# all current menus in collection will be returned.
# 
# Returns:
# Array. Of choices prepared for tree:select input field.
#######################################################################
def self.choices4_menu_as_tree(site_id=nil)
  qry = where(active: true)
# 
  ar = [nil]
  if site_id.class == BSON::ObjectId
    ar << site_id
  elsif site_id.respond_to?(:id)
    ar << site_id.id
  end
  qry = qry.in(dc_site_id: ar)
#
  result = []
  qry.each do |menu|
    result << [menu.name, menu.id, nil,0]
    sub_menus = menu.dc_menu_items.order_by(order: 1).to_a
    result += do_sub_menu(sub_menus, menu.id, menu.id.to_s) if sub_menus.size > 0
  end
  result
end

#######################################################################
# Will update link value of selected menu_item
# 
# Parameters: 
# [path] String. String path to MenuItem document, separated by ;
# [link] String. New value of the link field
#######################################################################
def self.update_menu_item_link(path, link)
  return unless path and link
# 
  ar = path.split(';')
  menu = find(ar.shift)
  while (item = ar.shift) do
    menu = menu.dc_menu_items.find(item)
  end
  return unless menu.respond_to?(:link) # top level selected
#  
  menu.link = link
  menu.save  
end

end