'use strict';



var CLASS_NAME = 'IsInRoleRule';



var util = require('util');

var t = require('../locales/i18n-bo.js')('Rules');

var Argument = require('../system/argument-check.js');

var AuthorizationRule = require('../rules/authorization-rule.js');

var UserInfo = require('../system/user-info.js');



/**

 * @classdesc

 *      The rule ensures that the user is member of a role.

 * @description

 *      Creates a new is-in-role rule object.

 *

 * @memberof bo.commonRules

 * @constructor

 * @param {bo.rules.AuthorizationAction} action - The action to be authorized.

 * @param {(bo.shared.PropertyInfo|string|null)} [target] - Eventual parameter of the authorization action.

 * @param {string} role - The name of the role the user is member of.

 * @param {string} message - Human-readable description of the rule failure.

 * @param {number} [priority=100] - The priority of the rule.

 * @param {boolean} [stopsProcessing=false] - Indicates the rule behavior in case of failure.

 *

 * @extends bo.rules.AuthorizationRule

 *

 * @throws {@link bo.system.ArgumentError Argument error}: The action must be a AuthorizationAction item.

 * @throws {@link bo.system.ArgumentError Argument error}: The target must be a PropertyInfo object in case of property read or write.

 * @throws {@link bo.system.ArgumentError Argument error}: The target must be a non-empty string in case of method execution.

 * @throws {@link bo.system.ArgumentError Argument error}: The target must be null in case of model actions.

 * @throws {@link bo.system.ArgumentError Argument error}: The role must be a non-empty string.

 * @throws {@link bo.system.ArgumentError Argument error}: The message must be a non-empty string.

 */

function IsInRoleRule (action, target, role, message, priority, stopsProcessing) {

  AuthorizationRule.call(this, 'IsInRole');



  /**

   * The name of the role the user is member of.

   * @type {string}

   * @readonly

   */

  this.role = Argument.inConstructor(CLASS_NAME).check(role).forMandatory('role').asString();



  // Initialize base properties.

  this.initialize(

      action,

      target,

      message || t('isInRole', role),

      priority,

      stopsProcessing

  );



  // Immutable object.

  Object.freeze(this);

}

util.inherits(IsInRoleRule, AuthorizationRule);



/**

 * Checks if the  user is member of the defined role.

 *

 * @abstract

 * @function bo.commonRules.IsInRoleRule#execute

 * @param {bo.system.UserInfo} userInfo - Information about the current user.

 * @returns {(bo.rules.AuthorizationResult|undefined)} Information about the failure.

 */

IsInRoleRule.prototype.execute = function (userInfo) {



  userInfo = Argument.inMethod(CLASS_NAME, 'execute')

      .check(userInfo).forOptional('userInfo').asType(UserInfo);



  var hasPermission = userInfo.isInRole(this.role);



  if (!hasPermission)

    return this.result(this.message);

};



module.exports = IsInRoleRule;