Merge qvicksilver/server_side_sorting

lib/controls/index.js

@@ -7,6 +7,7 @@ var EntryChangeNotificationControl =
   require('./entry_change_notification_control');
 var PersistentSearchControl = require('./persistent_search_control');
 var PagedResultsControl = require('./paged_results_control');
+var ServerSideSortingControl = require('./server_side_sorting_control.js');
 
 
 
@@ -57,6 +58,12 @@ module.exports = {
         value: value
       });
       break;
+    case ServerSideSortingControl.OID:
+      control = new ServerSideSortingControl({
+        critical: critical,
+        value: value
+      });
+      break;
     default:
       control = new Control({
         type: type,
@@ -72,5 +79,6 @@ module.exports = {
   Control: Control,
   EntryChangeNotificationControl: EntryChangeNotificationControl,
   PagedResultsControl: PagedResultsControl,
-  PersistentSearchControl: PersistentSearchControl
+  PersistentSearchControl: PersistentSearchControl,
+  ServerSideSortingControl: ServerSideSortingControl
 };

lib/controls/server_side_sorting_control.js

@@ -0,0 +1,137 @@
+var assert = require('assert');
+var util = require('util');
+
+var asn1 = require('asn1');
+
+var Control = require('./control');
+
+
+
+///--- Globals
+
+var BerReader = asn1.BerReader;
+var BerWriter = asn1.BerWriter;
+
+
+
+///--- API
+
+function ServerSideSortingControl(options) {
+  if (!options)
+    options = {};
+
+  options.type = ServerSideSortingControl.OID;
+  if (options.value) {
+    if (Buffer.isBuffer(options.value)) {
+      this.parse(options.value);
+    } else if (Array.isArray(options.value)) {
+      for (var i = 0; i < options.value.length; i++) {
+        if (!typeof (options.value[i]) === 'object') {
+          throw new TypeError('Elements of options.value must be Objects');
+        } else if (!options.value[i].hasOwnProperty('attributeType')) {
+          throw new Error('Missing required key: attributeType');
+        }
+      }
+      this._value = options.value;
+    } else if (typeof (options.value) === 'object') {
+      if (!options.value.hasOwnProperty('attributeType')) {
+        throw new Error('Missing required key: attributeType');
+      }
+      this._value = options.value;
+    } else {
+      throw new TypeError('options.value must be a Buffer, Array or Object');
+    }
+    options.value = null;
+  }
+  Control.call(this, options);
+
+  var self = this;
+  this.__defineGetter__('value', function () {
+    return self._value || {};
+  });
+}
+util.inherits(ServerSideSortingControl, Control);
+module.exports = ServerSideSortingControl;
+
+
+ServerSideSortingControl.prototype.parse = function parse(buffer) {
+  assert.ok(buffer);
+
+  var ber = new BerReader(buffer);
+
+  if (ber.readSequence(0x30)) {
+    this._value = [];
+
+    while (ber.readSequence(0x30)) {
+      var sortKeyListItem = this._parseSortKeyListItem(ber)
+      this._value.push(sortKeyListItem);
+    }
+
+    if (this._value.length == 1) {
+      this._value = this._value[0];
+    }
+
+    return true;
+  }
+
+  return false;
+};
+
+
+ServerSideSortingControl.prototype._toBer = function (ber) {
+  assert.ok(ber);
+
+  if (!this._value)
+    return;
+
+  var writer = new BerWriter();
+  writer.startSequence(0x30);
+
+  if (Array.isArray(this.value)) {
+    for (var i = 0; i < this.value.length; i++) {
+      this._sortKeyListItemToBer(writer, this.value[i]);
+    }
+  } else if (typeof (this.value) === 'object') {
+    this._sortKeyListItemToBer(writer, this.value);
+  }
+
+  writer.endSequence();
+  ber.writeBuffer(writer.buffer, 0x04);
+};
+
+
+ServerSideSortingControl.prototype._json = function (obj) {
+  obj.controlValue = this.value;
+  return obj;
+};
+
+ServerSideSortingControl.prototype._sortKeyListItemToBer = function(writer, obj) {
+  writer.startSequence(0x30);
+  if (obj.attributeType) {
+    writer.writeString(obj.attributeType, asn1.Ber.OctetString);
+  }
+  if (obj.orderingRule) {
+    writer.writeString(obj.orderingRule, 0x80);
+  }
+  if (obj.reverseOrder) {
+    writer.writeBoolean(obj.reverseOrder, 0x81);
+  }
+  writer.endSequence();
+};
+
+ServerSideSortingControl.prototype._parseSortKeyListItem = function(reader) {
+  var sortKeyListItem = {};
+  sortKeyListItem.attributeType = reader.readString(asn1.Ber.OctetString);
+
+  if (reader.peek() == 0x80) {
+    sortKeyListItem.orderingRule = reader.readString(0x80);
+  }
+
+  if (reader.peek() == 0x81) {
+    sortKeyListItem.reverseOrder = (reader._readTag(0x81) === 0 ? false : true);
+  }
+
+  return sortKeyListItem;
+};
+
+ServerSideSortingControl.OID = '1.2.840.113556.1.4.473';

test/controls/server_side_sorting_control_test.js

@@ -0,0 +1,99 @@
+
+var test = require('tap').test;
+
+var asn1 = require('asn1');
+
+var BerReader = asn1.BerReader;
+var BerWriter = asn1.BerWriter;
+var getControl;
+var ServerSideSortingControl;
+
+///--- Tests
+
+
+test('load library', function (t) {
+  ServerSideSortingControl =
+    require('../../lib').ServerSideSortingControl;
+  t.ok(ServerSideSortingControl);
+  getControl = require('../../lib').getControl;
+  t.ok(getControl);
+  t.end();
+});
+
+
+test('new no args', function (t) {
+  t.ok(new ServerSideSortingControl());
+  t.end();
+});
+
+
+test('new with args', function (t) {
+  var c = new ServerSideSortingControl({
+    type: '1.2.840.113556.1.4.473',
+    criticality: true,
+    value: {
+      attributeType: 'sn'
+    }
+  });
+  t.ok(c);
+  t.equal(c.type, '1.2.840.113556.1.4.473');
+  t.ok(c.criticality);
+  t.equal(c.value.attributeType, 'sn');
+
+  t.end();
+});
+
+test('tober - object', function (t) {
+  var sssc = new ServerSideSortingControl({
+    type: '1.2.840.113556.1.4.473',
+    criticality: true,
+    value: {
+      attributeType: 'sn',
+      orderingRule: 'caseIgnoreOrderingMatch',
+      reverseOrder: true
+    }});
+
+  var ber = new BerWriter();
+  sssc.toBer(ber);
+
+  var c = getControl(new BerReader(ber.buffer));
+  t.ok(c);
+  t.equal(c.type, '1.2.840.113556.1.4.473');
+  t.ok(c.criticality);
+  t.equal(c.value.attributeType, 'sn');
+  t.equal(c.value.orderingRule, 'caseIgnoreOrderingMatch');
+  t.equal(c.value.reverseOrder, true);
+
+  t.end();
+});
+
+test('tober - array', function (t) {
+  var sssc = new ServerSideSortingControl({
+    type: '1.2.840.113556.1.4.473',
+    criticality: true,
+    value: [{
+      attributeType: 'sn',
+      orderingRule: 'caseIgnoreOrderingMatch',
+      reverseOrder: true
+    },
+    {
+      attributeType: 'givenName',
+      orderingRule: 'caseIgnoreOrderingMatch'
+      }]
+  });
+
+  var ber = new BerWriter();
+  sssc.toBer(ber);
+
+  var c = getControl(new BerReader(ber.buffer));
+  t.ok(c);
+  t.equal(c.type, '1.2.840.113556.1.4.473');
+  t.ok(c.criticality);
+  t.equal(c.value[0].attributeType, 'sn');
+  t.equal(c.value[0].orderingRule, 'caseIgnoreOrderingMatch');
+  t.equal(c.value[0].reverseOrder, true);
+  t.equal(c.value[1].attributeType, 'givenName');
+  t.equal(c.value[1].orderingRule, 'caseIgnoreOrderingMatch');
+
+  t.end();
+});