Merge pull request #8 from ttys3/dict-sorted-by-keys

fix src/bdict.cc: dict keys should be sorted before encode

Author: Frederick888

src/bdict.cc

@@ -4,6 +4,7 @@
 #include "blist.h"
 #include "bstr.h"
 #include "zend_container.h"
+#include "zend_sort.h"
 #include <string>
 
 bdict::bdict()
@@ -241,6 +242,11 @@ zval bdict::parse(const std::string &ben, size_t &pt)
 std::string bdict::encode() const
 {
     std::string result = "d";
+
+    // according to BEP http://bittorrent.org/beps/bep_0003.html
+    // keys must be strings and appear in sorted order (sorted as raw strings, not alphanumerics).
+    zend_hash_sort_ex(_data, zend_sort, php_array_key_compare_string, 0);
+
     for (zend_hash_internal_pointer_reset(_data);
          zend_hash_has_more_elements(_data) == SUCCESS;
          zend_hash_move_forward(_data)) {

src/zend_container.h

@@ -3,6 +3,33 @@
 
 extern "C" {
 #include "php.h"
+
+// c func borrowed from https://github.com/php/php-src/blob/e08ce4c13db6e9aecd3497cd270b72d06c649bc7/ext/standard/array.c#L245
+static int php_array_key_compare_string(const void *a, const void *b)
+{
+    Bucket *f = (Bucket *)a;
+    Bucket *s = (Bucket *)b;
+    const char *s1, *s2;
+    size_t l1, l2;
+    char buf1[MAX_LENGTH_OF_LONG + 1];
+    char buf2[MAX_LENGTH_OF_LONG + 1];
+
+    if (f->key) {
+        s1 = f->key->val;
+        l1 = f->key->len;
+    } else {
+        s1 = zend_print_long_to_buf(buf1 + sizeof(buf1) - 1, f->h);
+        l1 = buf1 + sizeof(buf1) - 1 - s1;
+    }
+    if (s->key) {
+        s2 = s->key->val;
+        l2 = s->key->len;
+    } else {
+        s2 = zend_print_long_to_buf(buf2 + sizeof(buf2) - 1, s->h);
+        l2 = buf2 + sizeof(buf2) - 1 - s2;
+    }
+    return zend_binary_strcmp(s1, l1, s2, l2);
+}
 }
 
 #include "bdict.h"

tests/dict_ordered_keys.phpt

@@ -0,0 +1,15 @@
+--TEST--
+PHP Bencode - Dictionary Ordered Keys Test
+--FILE--
+<?php
+error_reporting(E_ALL);
+
+$unordered_encoded = 'd7:ttg_tag32:8032a74ec22927a5bd6367537eafd87e7:privatei1e6:source20:[ttys3.bencode.test]e';
+
+$bdict = bitem::parse($unordered_encoded);
+echo $bdict;
+
+exit(0);
+?>
+--EXPECTF--
+d7:privatei1e6:source20:[ttys3.bencode.test]7:ttg_tag32:8032a74ec22927a5bd6367537eafd87ee