API Docs for:
Show:

File: lib/acl.js

"use strict";

var Errors = require("./errors");

/**
* オブジェクトへのアクセス権限を設定するクラスです。
*
* DataStoreやUserクラスのインスタンスに付加して利用します。<br>
* 指定するユーザおよびロールはmobile backendに保存済みである必要があります。
* 
* @class NCMB.Acl
* 
* @param {Object} permissions Acl情報のJSONオブジェクト
*/
var Acl = module.exports = function(ncmb) {
  var reserved = [
    "set", "setReadAccess", "setWriteAccess",
    "setPublicReadAccess", "setPublicWriteAccess",
    "setUserReadAccess", "setUserWriteAccess",
    "setRoleReadAccess", "setRoleWriteAccess",
    "toJSON"];
  var isReserved = function(key){
    return reserved.indexOf(key) > -1;
  };

  function Acl(permissions) {
    if(permissions) {
      Object.keys(permissions).forEach(function(key){
        if(isReserved(key)){
          throw new Errors.UnReplaceableKeyError(key + " cannot be set, it is reserved.");
        }
        if(permissions[key] && (permissions[key].read || permissions[key].write)){
          if(permissions[key].read== false){
            permissions[key].read = true;
          }else if(permissions[key].write== false){
            permissions[key].write = true;
          }
          this[key] = permissions[key];
        }else{
          throw new Errors.InvalidArgumentError("Argument format is invalid.");
        }
      }.bind(this));
    }
  };

  Acl.prototype.set = function(target, type, allowed) {
    if(isReserved(target)){
      throw new Errors.UnReplaceableKeyError(target + " cannot be set, it is reserved.");
    }
    if (allowed == false) {
      if (this[target] && this[target][type] ) delete this[target][type];
      if (this[target] && Object.keys(this[target]).length == 0 ) delete this[target];
      return ;
    }
    this[target] = this[target] || {}; 
    this[target][type] = allowed;
    return this;
  };
  Acl.prototype.setReadAccess        = function(target, allowed) {
    return this.set(target, "read", allowed); 
  };
  Acl.prototype.setWriteAccess       = function(target, allowed) {
    return this.set(target, "write", allowed);
  };

  /**
  * 全体への読み込み権限を設定します。
  *
  * @method NCMB.Acl#setPublicReadAccess
  * @param {boolean} allowed true/false
  * @return {NCMB.Acl} 権限追加後のインスタンス
  */
  Acl.prototype.setPublicReadAccess  = function(allowed) {
    return this.setReadAccess("*", allowed);
  };

  /**
  * 全体への書き込み権限を設定します。
  *
  * @method NCMB.Acl#setPublicWriteAccess
  * @param {boolean} allowed true/false
  * @return {NCMB.Acl} 権限追加後のインスタンス
  */
  Acl.prototype.setPublicWriteAccess = function(allowed) {
    return this.setWriteAccess("*", allowed);
  };

  /**
  * 特定ユーザへの読み込み権限を設定します。
  *
  * @method NCMB.Acl#setUserReadAccess
  * @param {NCMB.User} user Userのインスタンス
  * @param {boolean} allowed true/false
  * @return {NCMB.Acl} 権限追加後のインスタンス
  */
  Acl.prototype.setUserReadAccess    = function(user, allowed) {
    if(!(user instanceof ncmb.User)){
      throw new Errors.InvalidArgumentError("First argument must be instance of ncmb.User.");
    }
    if(!user.objectId){
      throw new errors.NoObjectIdError("This user doesn't have objectId. Input user must be saved.");
    }
    return this.setReadAccess(user.objectId, allowed);
  };

  /**
  * 特定ユーザへの書き込み権限を設定します。
  *
  * @method NCMB.Acl#setUserWriteAccess
  * @param {NCMB.User} user Userのインスタンス
  * @param {boolean} allowed true/false
  * @return {NCMB.Acl} 権限追加後のインスタンス
  */
  Acl.prototype.setUserWriteAccess   = function(user, allowed) {
    if(!(user instanceof ncmb.User)){
      throw new Errors.InvalidArgumentError("First argument must be instance of ncmb.User.");
    }
    if(!user.objectId){
      throw new errors.NoObjectIdError("This user doesn't have objectId. Input user must be saved.");
    }
    return this.setWriteAccess(user.objectId, allowed);
  };

  /**
  * 特定ロールへの読み込み権限を設定します。
  * roleNameにロールのインスタンスを入力することもできます。
  *
  * @method NCMB.Acl#setRoleReadAccess
  * @param {string} roleName ロール名
  * @param {boolean} allowed true/false
  * @return {NCMB.Role} 権限追加後のインスタンス
  */
  Acl.prototype.setRoleReadAccess    = function(roleName, allowed) {
    if(roleName instanceof ncmb.Role){
      roleName = roleName.roleName;
    }
    if(typeof roleName !== "string" || roleName === ""){
      throw new Errors.NoRoleNameError("First argument must be roleName string or ncmb.Role instance that has roleName.");
    }
    var role = "role:" + roleName;
    return this.setReadAccess(role, allowed);
  };

  /**
  * 特定ロールへの書き込み権限を設定します。
  * roleNameにロールのインスタンスを入力することもできます。
  *
  * @method NCMB.Acl#setRoleWriteAccess
  * @param {string} roleName ロール名
  * @param {boolean} allowed true/false
  * @return {NCMB.Role} 権限追加後のインスタンス
  */
  Acl.prototype.setRoleWriteAccess   = function(roleName, allowed) {
    if(roleName instanceof ncmb.Role){
      roleName = roleName.roleName;
    }
    if(typeof roleName !== "string" || roleName === ""){
      throw new Errors.NoRoleNameError("First argument must be roleName string or ncmb.Role instance that has roleName.");
    }
    var role = "role:" + roleName;
    return this.setWriteAccess(role, allowed);
  };

  /**
  * 指定したユーザもしくはロールに設定されている権限を取得します。
  *
  * @method NCMB.Acl#get
  * @param {NCMB.User|NCMB.Role|string} target 権限を取得するユーザもしくはロールのインスタンス。全体の権限を取得する場合は"public"を入力
  * @param {string} type read/write
  * @return {NCMB.Role} true/false
  */
  Acl.prototype.get = function(target, type){
    if(target instanceof ncmb.Role && target.roleName){
      target = "role:" + target.roleName;
    }else if(target instanceof ncmb.User && target.objectId){
      target = target.objectId;
    }
    if(typeof target !== "string"){
      throw new Errors.InvalidArgumentError("First argument must be string or saved object.");
    }
    if(type !== "read" && type !== "write"){
      throw new Errors.InvalidArgumentError("Secondargument must be 'read' or 'write' only.");
    }
    if(target === "public") target = "*";
    if(!this[target]) return null;
    if(this[target][type] === false){
      return false;
    }else if(!this[target][type]){
      return null;
    }
    return this[target][type];
  };
  Acl.prototype.toJSON = function() {
    var permissions = {};
    for(var target in this){
      if(typeof this[target] !== "function"){
        permissions[target] = this[target];
      }
    }
    return permissions;
  };
  return Acl;
};

/**
 * @interface NCMB.AclConstructor
 */

/**
 * @method
 * @name NCMB.AclConstructor#new
 * @param {Object} [permissions] Acl情報のJSONオブジェクト
 * @return {NCMB.Acl}
 */