pEp.foundation
/
pEpJSONServerAdapter
9
1
Fork 4
Code Issues 1 Pull Requests Releases 1 Wiki Activity
p≡p JSON adapter
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
142 Commits
87 Branches
37 Tags
14 MiB
C++ 85.9%
JavaScript 6.7%
C 4.1%
HTML 1.6%
Makefile 1.1%
Other 0.6%
 
 
 
 
 
 
master
gitea-12
master+sequoia_openpgp_ffi
Release_2.1
old-retired-Release_3.1
JSON-202
JSON-203
JSON-200
JSON-198
JSON-199
lucasaiu/message-struct-change
JSON-955
MACOSINST-26
JSON-192
JSON-186
JSON-128
JSON-183
JSON-182
JSON-180
JSON-172
JSON-160
JSON-156
ENGINE-857
JSON-170
pEp4Thunderbird
new_sync
JSON-153
JSON-153_experimental
JSON-155
old_session_management
JSON-98
JSON-111
JSON-107
JSON-142
JSON-134
JSON-147
postrelease
JSON-152
default-01
new_session_management
JSON-143
sync
JSON-62
JSON-141
JSON-139
JSON-131
JSON-127
JSON-123
JSON-107-01
JSON-79
JSON-114
python-wrapper
JSON-54
JSON-104
JSON-102
JSON-108
JSON-110
JSON-106
JSON-103
JSON-97
JSON-105
JSON-101
JSON-90
JSON-95
JSON-93
JSON-92
JSON-80
JSON-75
JSON-75-01
JSON-77
JSON-71
JSON-50
JSON-59
JSON-23
JSON-57
JSON-35
JSON-28
JSON-30
JSON-32
ENGINE-9
ENGINE-187
JSON-27
JSON-15
JSON-2
no_SessionID_in_API
as-a-library
refactor-result-recursion
Release_2.1.0
Release_2.1.0-RC0
Release_2.1.0-RC1
Release_2.1.0-RC10
Release_2.1.0-RC11
Release_2.1.0-RC12
Release_2.1.0-RC13
Release_2.1.0-RC14
Release_2.1.0-RC15
Release_2.1.0-RC16
Release_2.1.0-RC17
Release_2.1.0-RC17+MakefileFix
Release_2.1.0-RC18
Release_2.1.0-RC19
Release_2.1.0-RC2
Release_2.1.0-RC3
Release_2.1.0-RC4
Release_2.1.0-RC5
Release_2.1.0-RC6
Release_2.1.0-RC7
Release_2.1.0-RC8
Release_2.1.0-RC9
Release_2.1.1
Release_2.1.2
Release_2.1.3
Release_2.1.4
Release_2.1.5
Release_2.1.6
Release_2.2.0-RC1
Release_3.1.0-RC1
Release_3.1.0-RC2
Release_3.1.0-RC3
last_Out_with_pointer_value
old_pre-sync_default
release_enigmail_2.0.0
v3.2.0-RC0
v3.2.0-RC1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '5a6d125e70'
${ noResults }
Go to file
Roker 5a6d125e70 start branch JSON-15 7 years ago
html add support for "backslash escape sequence" decoding in input strings 7 years ago
libevent-2.0.22-stable Initial check-in / Erstlingseinfügung / inserire iniziale intenzionale / Первый чек-ин 7 years ago
server JSON-11: bring get_trustwords() into the JSON API, remove old trustwords() function. new version "(21) Untereschbach" 7 years ago
.hgignore Ability to build on OS X, server is runnable. 7 years ago
README-OSX.md README: How to satisfy -luuid on OS-X 7 years ago
README.md reformat README.md 7 years ago

README.md

  1. Dependencies =================

Debian

  • g++ 4.8 or 4.9
  • GNU make
  • libboost-filesystem-dev
  • p≡p Engine (which needs gpgme-thread, a patched libetpan, libboost-system-dev)

It comes with libevent 2.20, that needs GNU autohell to build. :-/ Maybe Debian Jessie's version 2.0 also works well, I never tried.

  1. Build ==========

  • build p≡p Engine

  • first build libevent, see libevent-2.0.22-stable/README (a user-install in $HOME/local/ is fine)

  • edit the library and include paths server/Makefile so p≡p & libevent will be found

  • run "make" in the server/ path

  1. Running ============

  • run ./mt-server

  • visit http://127.0.0.1:4223/ in your javascript-enabled web browser to see the test JavaScript client

  • call some functions ("version()" or "get_gpg_path()" should work just fine)

  1. Extending / Customizing ============================

  • The 'FunctionMap function' in mt-server.cc defines which functions are callable via the JSON-RPC interface. The existing entries show the syntax of that map.

  • At the moment only functions with a non-void return type ere supported. It is possible to extend the FunctionMap to support also void-returning functions if desired, but it would require more template specializations in function_map.hh etc. The alternative is a helper function that calls the void function and just returns a dummy value.

  • The current implementation supports input and output parameters, no "inout".

  • For each type there must exist specializations of the template classes "In" (for input parameters) and "Out" (for output parameters). The linker will tell you, which specializations are needed. ;-)

  • The specializations for "generic types" are in function_map.cc

  • The specializations for "p≡p-specific types" are in pep-types.cc

  1. TODO =========

  • Add unit tests (I'd suggest GoogleTest/gtest? Any complaints?)

  • Fix the bugs that are found by the Unit tests, if any.

  • Let's generate all the tedious boiler plate code

    • the content of pep-types.cc
    • perhaps the FunctionMap 'function' in mt-server.cc
    • perhaps the JavaScript side of the HTML test page to ensure to be consistent with the server side in pep-types.cc

  • Adapt the "p≡p Transport API", when it is final. (either manually or by code generator, if ready)