node-ldapjs/lib/attribute.js

// Copyright 2011 Mark Cavage, Inc.  All rights reserved.

var assert = require('assert');

var asn1 = require('asn1');

var Protocol = require('./protocol');

var settings = {};
// specifies Guid display format, not defined (and unobstrusive) by default
settings.guid_format = '';

///--- API

function Attribute(options) {
  if (options) {
    if (typeof (options) !== 'object')
      throw new TypeError('options must be an object');
    if (options.type && typeof (options.type) !== 'string')
      throw new TypeError('options.type must be a string');
  } else {
    options = {};
  }

  var self = this;

  this.type = options.type || '';
  this._vals = [];

  this.__defineGetter__('vals', function () {
    var _vals = [];

    self._vals.forEach(function (v) {
      /* JSSTYLED */
      if (/;binary$/.test(self.type)) {
        _vals.push(v.toString('base64'));
      } else {
        _vals.push(v.toString('utf8'));
      }
    });

    // processing of objectGUID attribute value
    if (/objectGUID$/.test(self.type)) {
      // check whether custom display format was defined
      if (settings && settings.guid_format && settings.guid_format.length > 0) {
        // ensure objectGUID value is present within buffers
        var _buffers = self._vals;
        if (_buffers && _buffers.length > 0 && Buffer.isBuffer(_buffers[0])) {
          // return formatted value as per settings
          return formatGuid(settings.guid_format, _buffers[0]);
        }
      }
    }

    return _vals;
  });

  this.__defineSetter__('vals', function (vals) {
    if (Array.isArray(vals)) {
      vals.forEach(function (v) {
        self.addValue(v);
      });
    } else {
      self.addValue(vals);
    }
  });

  this.__defineGetter__('buffers', function () {
    return self._vals;
  });

  this.__defineGetter__('json', function () {
    return {
      type: self.type,
      vals: self.vals
    };
  });

  if (options.vals !== undefined)
    this.vals = options.vals;

}
module.exports = Attribute;
module.exports.settings = settings;

Attribute.prototype.addValue = function (val) {
  if (Buffer.isBuffer(val)) {
    this._vals.push(val);
  } else {
    var encoding = 'utf8';
    /* JSSTYLED */
    if (/;binary$/.test(this.type))
      encoding = 'base64';
    this._vals.push(new Buffer(val + '', encoding));
  }
};


/* BEGIN JSSTYLED */
Attribute.compare = function compare(a, b) {
  if (!(a instanceof Attribute) || !(b instanceof Attribute))
    throw new TypeError('can only compare Attributes');

  if (a.type < b.type) return -1;
  if (a.type > b.type) return 1;
  if (a.vals.length < b.vals.length) return -1;
  if (a.vals.length > b.vals.length) return 1;

  for (var i = 0; i < a.vals.length; i++) {
    if (a.vals[i] < b.vals[i]) return -1;
    if (a.vals[i] > b.vals[i]) return 1;
  }

  return 0;
};
/* END JSSTYLED */


Attribute.prototype.parse = function (ber) {
  assert.ok(ber);

  ber.readSequence();
  this.type = ber.readString();

  if (ber.peek() === Protocol.LBER_SET) {
    if (ber.readSequence(Protocol.LBER_SET)) {
      var end = ber.offset + ber.length;
      while (ber.offset < end)
        this._vals.push(ber.readString(asn1.Ber.OctetString, true));
    }
  }

  return true;
};


Attribute.prototype.toBer = function (ber) {
  assert.ok(ber);

  ber.startSequence();
  ber.writeString(this.type);
  ber.startSequence(Protocol.LBER_SET);
  if (this._vals.length) {
    this._vals.forEach(function (b) {
      ber.writeByte(asn1.Ber.OctetString);
      ber.writeLength(b.length);
      for (var i = 0; i < b.length; i++)
        ber.writeByte(b[i]);
    });
  } else {
    ber.writeStringArray([]);
  }
  ber.endSequence();
  ber.endSequence();

  return ber;
};

Attribute.toBer = function (attr, ber) {
  return Attribute.prototype.toBer.call(attr, ber);
};


/* BEGIN JSSTYLED */
Attribute.isAttribute = function (attr) {
  if (!attr) return false;
  if (typeof (attr) !== 'object') return false;
  if (attr instanceof Attribute) return true;
  if (!attr.type || typeof (attr.type) !== 'string') return false;
  if (!attr.vals || !Array.isArray(attr.vals)) return false;
  for (var i = 0; i < attr.vals.length; i++) {
    if (typeof (attr.vals[i]) !== 'string' && !Buffer.isBuffer(attr.vals[i]))
      return false;
  }

  return true;
};
/* END JSSTLYED */


Attribute.prototype.toString = function () {
  return JSON.stringify(this.json);
};

function formatGuid(format, data) {
  for (var i = 0; i < data.length; i++) {
    var re = new RegExp('\\{' + i + '\\}', 'g');
    // Leading 0 is needed if value of data[i] is less than 16 (of 10 as hex). 
    var dataStr = data[i].toString(16);
    format = format.replace(re, data[i] >= 16 ? dataStr : '0' + dataStr);
  }
  return format;
}