anoubis 1.0.0

data/app/models/anoubis/tenant/group_menu.rb

@@ -0,0 +1,84 @@
+##
+# Model links {Menu} and {Group}. Describes group access to menu.
+class Anoubis::Tenant::GroupMenu < Anoubis::Core::ApplicationRecord
+  # Redefines default table name
+  self.table_name = 'group_menus'
+
+  before_validation :before_validation_group_menu
+  after_create :after_create_group_menu
+  before_update :before_update_group_menu
+  after_destroy :after_destroy_group_menu
+
+
+  # @!attribute group
+  #   @return [Group] reference to the {Group} model
+  belongs_to :group, :class_name => 'Anoubis::Tenant::Group'
+  validates :group, presence: true, uniqueness: { scope: [:menu_id] }
+
+  # @!attribute menu
+  #   @return [Menu] reference to the {Menu} model
+  belongs_to :menu, :class_name => 'Anoubis::Tenant::Menu'
+  validates :menu, presence: true, uniqueness: { scope: [:group_id] }
+
+  # @!attribute access
+  #   @return ['not', 'read', 'write', 'disable'] group access to menu element.
+  #     - 'not' --- menu element doesn't available for this group
+  #     - 'read' --- group has access to menu element only for read data
+  #     - 'write' --- group has access to menu element for read and write data
+  #     - 'disable' --- group hasn't access to menu element
+  enum access: { not: 0, read: 20, write: 40, disable: 60 }
+
+  ##
+  # Is called before validation when the link between menu and group is being created or updated.
+  # Procedure checks if group belongs a system that has access to this menu element. If {#access} doesn't
+  # defined then {#access} sets to 'read'
+  def before_validation_group_menu
+    if !Anoubis::Tenant::SystemMenu.where(system_id: self.group.system_id, menu_id: self.menu_id).first
+      errors.add(:base, I18n.t('anubis.group_menus.errors.no_access'))
+      throw(:abort, __method__)
+    end
+    self.access = Anubis::Tenant::GroupMenu.accesses[:read] if !self.access
+  end
+
+  ##
+  # Is called after new link between menu and group was created. If new element has parent with link that
+  # doesn't present in database then adds this link to database with {#access} defined as 'read'.
+  def after_create_group_menu
+    if self.menu.menu_id != nil
+      Anubis::Tenant::GroupMenu.find_or_create_by(menu_id: self.menu.menu_id, group_id: self.group_id) do |menu|
+        menu.access = Anubis::Tenant::GroupMenu.accesses[:read]
+      end
+    end
+    self.after_modify_group_menu
+  end
+
+  ##
+  # Is called before link between menu and group will be updated. Procedure prevents changing {#menu}
+  # and {#group} value.
+  def before_update_group_menu
+    self.menu_id = self.menu_id_was if self.menu_id_changed?
+    self.group_id = self.group_id_was if self.group_id_changed?
+    self.after_modify_group_menu
+  end
+
+  ##
+  # Is called after link between menu and group had been deleted from database. It also deletes all child links.
+  def after_destroy_group_menu
+    Anubis::Tenant::Menu.select(:id).where(menu_id: self.menu_id).each do |menu|
+      Anubis::Tenant::GroupMenu.where(menu_id: menu.id, group_id: self.group_id).each do |group_menu|
+        group_menu.destroy
+      end
+    end
+    self.after_modify_group_menu
+  end
+
+  ##
+  # Deletes all user's keys that belong this menu element in Redis database.
+  def after_modify_group_menu
+    if self.redis
+      self.redis.keys(self.redis_prefix + '*_'+self.menu.mode).each do |data|
+        self.redis.del data
+      end
+    end
+  end
+end

data/app/models/anoubis/tenant/menu.rb

@@ -0,0 +1,156 @@
+##
+# Menu model. Stores information about all menu elements of the portal. Menu model defines the dependence
+# between controller and user access.
+class Anubis::Tenant::Menu < ApplicationRecord
+  # Redefines default table name
+  self.table_name = 'menus'
+
+  before_create :before_create_menu
+  before_update :before_update_menu
+  before_save :before_save_menu
+  before_destroy :before_destroy_menu
+  after_destroy :after_destroy_menu
+
+  # @!attribute mode
+  #   @return [String] the controller path for menu element.
+  validates :mode, presence: true, uniqueness: true
+
+  # @!attribute action
+  #   @return [String] the default action of menu element ('data', 'menu', etc.).
+  validates :action, presence: true
+
+  # @!attribute tab
+  #   @return [Integer] the nesting level of menu element
+  validates :tab, presence: true, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
+
+  # @!attribute position
+  #   @return [Integer] the order position of menu element in current level.
+  validates :position, presence: true, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
+
+  # @!attribute page_size
+  #   @return [Integer] the default page size for table of data frame.
+  validates :page_size, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
+
+  # @!attribute menu
+  #   @return [Menu, nil] the parent menu for element menu (if exists).
+  belongs_to :menu, class_name: 'Anubis::Tenant::Menu', optional: true
+  has_many :menus, class_name: 'Anubis::Tenant::Menu'
+
+  has_many :group_menus, class_name: 'Anubis::Tenant::GroupMenu'
+  has_many :system_menus, class_name: 'Anubis::Tenant::SystemMenu'
+  has_many :menu_locales, class_name: 'Anubis::Tenant::MenuLocale'
+
+  # @!attribute status
+  #   @return ['enabled', 'disabled'] the status of menu element.
+  #     - 'enabled' --- element is enabled and is used by the system.
+  #     - 'disabled' --- element is disabled and isn't used by the system.
+  enum status: { enabled: 0, disabled: 1 }
+
+  # @!attribute state
+  #   @return ['visible', 'hidden'] the visibility of menu element. Attribute is used in fronted application.
+  #     - 'visible' --- element is visible.
+  #     - 'hidden' --- element is hidden.
+  enum state: { visible: 0, hidden: 1 }
+
+  ##
+  # Is called before menu will be created in database. Sets {#position} as last {#position} + 1 on current {#tab}.
+  # After this calls {#before_update_menu} for additional modification.
+  def before_create_menu
+    data = Anubis::Tenant::Menu.where(menu_id: self.menu_id).maximum(:position)
+    self.position = if data then data + 1 else 0 end
+
+    self.before_update_menu
+  end
+
+  ##
+  # Is called before menu will be stored in database. Sets {#mode} and {#action} in lowercase. If {#page_size}
+  # doesn't defined then sets it to 20. If defined parent menu element then sets {#tab} based on {#tab} of
+  # parent menu element + 1.
+  def before_update_menu
+    self.mode = mode.downcase
+    self.action = self.action.downcase
+    self.page_size = 20 if !self.page_size
+    self.page_size = self.page_size.to_i
+
+    parent_menu = Anubis::Tenant::Menu.where(id: self.menu_id).first
+    if parent_menu
+      self.tab = parent_menu.tab + 1
+    else
+      self.tab = 0
+    end
+  end
+
+  ##
+  # Is called right before menu will be stored in database (after {#before_create_menu} and {#before_update_menu}).
+  # Deletes cache data for this menu in Redis database.
+  def before_save_menu
+    self.redis.del(self.redis_prefix + 'menu_' + self.mode) if self.redis
+  end
+
+  ##
+  # Is called before menu will be deleted from database. Checks the ability to destroy a menu. Delete
+  # all translations for menu model from {MenuLocale}.
+  def before_destroy_menu
+    Anubis::Tenant::MenuLocale.where(menu_id: self.id).each do |menu_locale|
+      menu_locale.destroy
+    end
+
+    if !can_destroy?
+      errors.add(:base, I18n.t('anubis.menus.errors.has_childs'))
+      throw(:abort, __method__)
+    end
+    #childs = !self.menus.empty?
+    #childs = !self.group_menus.empty? if !childs
+    #childs = !self.system_menus.empty? if !childs
+
+    #return if !childs
+
+    #errors.add(:base, I18n.t('menus.errors.has_childs'))
+    #throw(:abort, __method__)
+  end
+
+  ##
+  # Is called after menu was deleted from database. Procedure recalculates position of other menu elements.
+  def after_destroy_menu
+    query = <<-SQL
+            UPDATE menus
+            SET menus.position = menus.position - 1
+            WHERE menus.tab = #{self.tab} AND menus.position > #{self.position}
+    SQL
+    Anubis::Tenant::Menu.connection.execute query
+    #i = self.position
+    #Anubis::Tenant::Menu.where(menu_id: self.menu_id, position: (self.position+1..Float::INFINITY)).find_each do |menu|
+    #        menu.position = i
+    #        menu.save
+    #        i += 1
+    #      end
+    Anubis::Tenant::Menu.where(menu_id: self.id).find_each do |menu|
+      menu.destroy
+    end
+  end
+
+  ##
+  # Returns model localization data from {MenuLocale}.
+  # @return [MenuLocale] localization for current menu
+  def model_locale
+    @model_locale ||= self.menu_locales.where(locale: Anubis::Tenant::MenuLocale.locales[self.current_locale.to_sym]).first
+  end
+
+  # @!attribute title
+  # @return [String] the menu's title. Title loads from {MenuLocale#title} based on {#current_locale}
+  def title
+    self.model_locale.title if self.model_locale
+  end
+
+  # @!attribute page_title
+  # @return [String] the menu's page title. Page title loads from {MenuLocale#page_title} based on {#current_locale}
+  def page_title
+    self.model_locale.page_title if self.model_locale
+  end
+
+  # @!attribute short_title
+  # @return [String] the menu's short title. Short title loads from {MenuLocale#short_title} based on {#current_locale}
+  def short_title
+    self.model_locale.short_title if self.model_locale
+  end
+end

data/app/models/anoubis/tenant/menu_locale.rb

@@ -0,0 +1,27 @@
+##
+# Localization for {Menu} model. Model stores all translations for {Menu} model.
+class Anoubis::Tenant::MenuLocale < Anoubis::Core::ApplicationRecord
+  # Redefines default table name
+  self.table_name = 'menu_locales'
+
+  # @!attribute menu
+  #   @return [Menu] reference to the {Menu} model
+  belongs_to :menu, :class_name => 'Anoubis::Tenant::Menu'
+  validates :menu, presence: true, uniqueness: { scope: [:locale] }
+
+  # @!attribute title
+  #   @return [String] the menu's localized title
+  validates :title,  presence: true, length: { minimum: 3, maximum: 100 }
+
+  # @!attribute page_title
+  #   @return [String] the menu's localized page title. Uses in frontend application.
+  validates :page_title,  presence: true, length: { minimum: 3, maximum: 200 }
+
+  # @!attribute short_title
+  #   @return [String] the menu's localized short title. Uses in frontend application.
+  validates :short_title,  length: { maximum: 200 }
+
+  # @!attribute locale
+  #   @return [Locales] reference to locale
+  enum locale: Anoubis::Core::Locales.enums
+end

data/app/models/anoubis/tenant/system.rb

@@ -0,0 +1,127 @@
+##
+# System model. Stores information about all portal's systems.
+class Anoubis::Tenant::System < Anoubis::Core::ApplicationRecord
+  # Redefines default table name
+  self.table_name = 'systems'
+
+  before_validation :before_validation_system_create, on: :create
+  before_validation :before_validation_system_update, on: :update
+  after_create :after_create_system
+  before_save :before_save_system
+  after_update :after_update_system
+  before_destroy :before_destroy_system
+
+  # System's identifier consists of lowercase alphabetic symbols.
+  VALID_SYSTEM_REGEX = /[a-z]\z/i
+
+  # @!attribute ident
+  #   @return [String] the system's identifier. Identifier consists of lowercase alphabetical symbols.
+  validates :ident, length: { minimum: 3, maximum: 15 }, uniqueness: true, format: { with: VALID_SYSTEM_REGEX }
+
+  has_many :tenant_systems, class_name: 'Anoubis::Tenant::TenantSystem'
+  has_many :groups, class_name: 'Anoubis::Tenant::Group'
+  has_many :system_menus, class_name: 'Anoubis::Tenant::SystemMenu'
+  has_many :system_locales, class_name: 'Anoubis::Tenant::SystemLocale'
+
+  ##
+  # Is called before validation when new system is being created. If it's a first system then it sets {#ident}
+  # value to 'sys'
+  def before_validation_system_create
+    if self.id
+      if self.id == 1
+        self.ident = 'sys'
+        return true
+      end
+    end
+  end
+
+  ##
+  # Is called before validation when system is being updated. Prevents the changing {#ident} value for
+  # system with id 1.
+  def before_validation_system_update
+    if self.id == 1 && self.ident_was != self.ident
+      errors.add(:ident, I18n.t('anubis.systems.errors.cant_change_ident'))
+      throw(:abort, __method__)
+    end
+  end
+
+  ##
+  # Is called after new system was created. Creates administration group for new system.
+  def after_create_system
+    if self.id == 1
+      data = Anoubis::Tenant::Group.create(id: 1)
+      I18n.available_locales.each do |locale|
+        I18n.locale = locale
+        Anoubis::Tenant::GroupLocale.find_or_create_by(group_id: data.id, locale: Anoubis::Tenant::MenuLocale.locales[locale.to_s.to_sym]) do |system_locale|
+          system_locale.title = I18n.t('anubis.install.admins_group')
+        end
+      end
+    else
+      data = Anoubis::Tenant::Group.find_or_create_by(ident: 'admin', system_id: self.id)
+      I18n.available_locales.each do |locale|
+        I18n.locale = locale
+        Anubis::Tenant::GroupLocale.find_or_create_by(group_id: data.id, locale: Anubis::Tenant::MenuLocale.locales[locale.to_s.to_sym]) do |system_locale|
+          system_locale.title = I18n.t('anubis.install.admins_group')
+        end
+      end
+    end
+  end
+
+  ##
+  # Is called before system will be stored in database. Changes {#ident} value to lower case.
+  def before_save_system
+    self.ident = self.ident.downcase if self.ident
+  end
+
+  ##
+  # Is called after system had been updated. If {#ident} value had been changed then procedure updates
+  # every {Anubis::Group#full_ident} value.
+  def after_update_system
+    if self.ident_was != self.ident
+      update_groups_full_ident self.id, self.ident
+    end
+  end
+
+  ##
+  # Is called before system will be deleted from database. Checks the ability to destroy a system. Delete
+  # all translations for system model from {GroupLocale}.
+  def before_destroy_system
+    if self.id == 1
+      errors.add(:base, I18n.t('anubis.tenants.errors.cant_destroy'))
+      throw(:abort, __method__)
+    end
+
+    Anubis::Tenant::SystemLocale.where(system_id: self.id).each do |system_locale|
+      system_locale.destroy
+    end
+
+    if !can_destroy?
+      errors.add(:base, I18n.t('anubis.tenants.errors.has_childs'))
+      throw(:abort, __method__)
+    end
+  end
+
+  ##
+  # Updates {Group#full_ident} when changed system's identifier.
+  # @param id [Integer] group unique identifier
+  # @param ident [String] new system identifier
+  def update_groups_full_ident (id, ident)
+    query = <<-SQL
+            UPDATE groups SET groups.full_ident = CONCAT('#{ident}.', groups.ident) WHERE groups.system_id = #{id}
+    SQL
+    Anubis::Tenant::Group.connection.execute query
+  end
+
+  ##
+  # Returns model localization data from {SystemLocale}.
+  # @return [SystemLocale] localization for current system
+  def model_locale
+    @model_locale ||= self.system_locales.where(locale: Anubis::Tenant::SystemLocale.locales[self.current_locale.to_sym]).first
+  end
+
+  # @!attribute title
+  # @return [String] the system's title. Title loads from {SystemLocale#title} based on {#current_locale}
+  def title
+    self.model_locale.title if self.model_locale
+  end
+end

data/app/models/anoubis/tenant/system_locale.rb

@@ -0,0 +1,19 @@
+##
+# Localization for {System} model. Model stores all translations for {System} model.
+class Anoubis::Tenant::SystemLocale < Anoubis::Core::ApplicationRecord
+  # Redefines default table name
+  self.table_name = 'system_locales'
+
+  # @!attribute title
+  #   @return [String] the system's localized title
+  validates :title, length: { minimum: 3, maximum: 100 }, uniqueness: { scope: [:system_id, :locale] }
+
+  # @!attribute system
+  #   @return [System] reference to the {System} model
+  belongs_to :system, :class_name => 'Anoubis::Tenant::System'
+  validates :system, presence: true, uniqueness: { scope: [:locale] }
+
+  # @!attribute locale
+  #   @return [Locales] reference to locale
+  enum locale: Anoubis::Core::Locales.enums
+end

data/app/models/anoubis/tenant/system_menu.rb

@@ -0,0 +1,51 @@
+##
+# Model links menu and systems. Describes if system has access to menu.
+class Anoubis::Tenant::SystemMenu < Anoubis::Core::ApplicationRecord
+  # Redefines default table name
+  self.table_name = 'system_menus'
+
+  after_create :after_create_system_menu
+  after_destroy :after_destroy_system_menu
+
+  # @!attribute system
+  #   @return [System] reference to the {System} model
+  belongs_to :system, class_name: 'Anoubis::Tenant::System'
+  validates :system, presence: true, uniqueness: { scope: [:menu_id] }
+
+  # @!attribute menu
+  #   @return [Menu] reference to the {Menu} model
+  belongs_to :menu, class_name: 'Anoubis::Tenant::Menu'
+  validates :menu, presence: true, uniqueness: { scope: [:system_id] }
+
+  ##
+  # Is called after create new link between system and menu. If created element has parent element and
+  # link to this parent element doesn't present in database then adds this link too.
+  def after_create_system_menu
+    if self.menu.menu_id != nil
+      Anoubis::Tenant::SystemMenu.find_or_create_by(menu: self.menu.menu, system: self.system)
+    end
+  end
+
+  ##
+  # Is called after link between system and menu was deleted from database. It also deletes all child links.
+  def after_destroy_system_menu
+    ids = []
+
+    Anoubis::Tenant::Menu.where(menu_id: self.menu_id).each do |data|
+      ids.push data.id
+    end
+
+    Anoubis::Tenant::SystemMenu.where(menu_id: ids, system_id: self.system_id).each do |data|
+      data.destroy
+    end
+
+    ids = []
+    Anoubis::Tenant::Group.where(system_id: self.system_id).each do |data|
+      ids.push data.id
+    end
+
+    Anoubis::Tenant::GroupMenu.where(menu_id: self.menu_id, group_id: ids).each do |data|
+      data.destroy
+    end
+  end
+end

data/app/models/anoubis/tenant/tenant.rb

@@ -0,0 +1,107 @@
+##
+# Tenant model. Stores information about all portal's tenants.
+class Anoubis::Tenant::Tenant < Anoubis::Core::ApplicationRecord
+  # Redefines default table name
+  self.table_name = 'tenants'
+
+  before_validation :before_validation_tenant_create, on: :create
+  before_validation :before_validation_tenant_update, on: :update
+  before_save :before_save_tenant
+  after_create :after_create_tenant
+  after_update :after_update_tenant
+  before_destroy :before_destroy_tenant
+
+  # Tenant's identifier consists of lowercase alphabetic symbols.
+  VALID_TENANT_REGEX = /[a-z]\z/i
+
+  # @!attribute ident
+  #   @return [String] the tenant's identifier. Identifier consists of lowercase alphabetical symbols.
+  validates :ident, length: { minimum: 3, maximum: 10 }, uniqueness: true, format: { with: VALID_TENANT_REGEX }
+
+  # @!attribute title
+  #   @return [String] the tenant's title
+  validates :title, length: { minimum: 5, maximum: 100 }, uniqueness: true
+
+  # @!attribute state
+  #   @return ['standard', 'default'] the tenant's status.
+  #     - 'default' --- tenant is marked as default (only one tenant may be default)
+  #     - 'standard' --- tenant is marked as standard
+  enum state: { standard: 0, default: 1 }
+
+  has_many :tenant_systems, class_name: 'Anoubis::Tenant::TenantSystem'
+
+  ##
+  # Is called before validation when new tenant is being created. If it's a first tenant then it sets {#ident}
+  # value to 'sys'
+  def before_validation_tenant_create
+    if self.id
+      if self.id == 1
+        self.ident = 'sys'
+        return true
+      end
+    end
+  end
+
+  ##
+  # Is called before validation when tenant is being updated. Prevents the changing {#ident} value.
+  def before_validation_tenant_update
+    if self.id == 1 && self.ident != self.ident_was
+      errors.add(:ident, I18n.t('anubis.tenants.errors.cant_change_ident'))
+      throw(:abort, __method__)
+    end
+  end
+
+  ##
+  # Is called after new tenant was created. Adds access for this tenant to main system with id 1.
+  def after_create_tenant
+    Anoubis::Tenant::TenantSystem.find_or_create_by(tenant_id: self.id, system_id: 1) if self.id != 1
+  end
+
+  ##
+  # Is called after tenant had been updated. If {#ident} value had been changed then procedure updates
+  # every {Anoubis::User#login} value.
+  # Also if current tenant {#state} value had been set as 'default', then procedure sets {#state}
+  # value of all other tenants as 'standard'.
+  def after_update_tenant
+    if self.ident_was != self.ident
+      self.update_users_login self.id, self.ident
+    end
+
+    # If current tenant had been set as 'default', then sets all other tenants as 'standard'.
+    if self.state != self.state_was && self.state = 'default'
+      Anoubis::Tenant::Tenant.where(state: Anoubis::Tenant::Tenant.states[:default]).update_all(state: Anoubis::Tenant::Tenant.states[:standard])
+    end
+  end
+
+  ##
+  # Is called before tenant will be stored in database. Changes {#ident} value to lower case.
+  def before_save_tenant
+    self.ident = self.ident.downcase if self.ident
+  end
+
+  ##
+  # Is called before tenant will be deleted from database. Checks the ability to destroy a tenant.
+  def before_destroy_tenant
+    if self.id == 1
+      errors.add(:base, I18n.t('anubis.tenants.errors.cant_destroy'))
+      throw(:abort, __method__)
+    end
+
+    if !can_destroy?
+      errors.add(:base, I18n.t('anubis.tenants.errors.has_childs'))
+      throw(:abort, __method__)
+    end
+  end
+
+  ##
+  # Changes every {User#login} value based on {#ident} value. Procedure makes direct update
+  # in database and doesn't call any callbacks of {Anoubis::Tenant::User} model.
+  # @param id [Integer] user unique identifier
+  # @param ident [String] new tenant identifier
+  def update_users_login (id, ident)
+    query = <<-SQL
+            UPDATE users SET users.login = CONCAT(users.email, '.#{ident}') WHERE users.tenant_id = #{id}
+    SQL
+    Anoubis::Tenant::User.connection.execute query
+  end
+end

data/app/models/anoubis/tenant/tenant_system.rb

@@ -0,0 +1,19 @@
+##
+# Model for links Tenant and System models
+class Anoubis::Tenant::TenantSystem < ApplicationRecord
+  self.table_name = 'tenant_systems'
+
+  before_update :before_update_tenant_system
+
+  belongs_to :tenant, class_name: 'Anoubis::Tenant::Tenant'
+  validates :tenant, presence: true, uniqueness: { scope: [:system_id] }
+  belongs_to :system, class_name: 'Anoubis::Tenant::System'
+  validates :system, presence: true, uniqueness: { scope: [:tenant_id] }
+
+  ##
+  # Checks before update data in model. Prevents from changing element data
+  def before_update_tenant_system
+    self.tenant_id = self.tenant_id_was if self.tenant_id_changed?
+    self.system_id = self.system_id_was if self.system_id_changed?
+  end
+end