Merge branch '4-adding-more-documentation' into 'master'

Adding API, webservice doc, copyrights headers

Closes #4

See merge request !8

source/api/api.rst

+FusionDirectory API
+===================
+
+FusionDirectory API is called simplePlugin and is documented automatically at each build.
+
+`FusionDirectory API <http://api.fusiondirectory.org/index.html>`_

source/api/index.rst

+API
+===
+
+FusionDirectory 
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+   webservice
+

source/api/webservice.rst

+Fusiondirectory WebService
+==========================
+
+FusionDirectory WebService plugin exposes a JSONRPC webservice you can use if you want to access LDAP content through FusionDirectory system.
+This way, you ensure that things like foreign keys are kept consistent, and you have a nicer API than the low-level LDAP one.
+
+It is a standard JSONRPC server served on HTTPS protocol. 
+
+Note that you can allow HTTP in plugin configuration, but please avoid doing so except for testing purposes.
+
+The `webservice methods are detailed here <http://api.fusiondirectory.org/classfdRPCService.html#details>`_.
+
+Basically you first need to call **login** to get a session ticket you’ll use in the other method calls you make.
+If you have several LDAP configured you might call **listLdaps** first to list them and specify which one to use as first parameter of **login** (otherwise just pass NULL as first parameter).
+
+Then you can use **ls** to list objects of a given type (list types with **listTypes** first if needed).
+**getfields** method will give you the fields of a given type (and tab) and **setfields** will allow you to change the value of these fields.
+
+
+.. code-block:: php
+
+  <?php
+
+  /* You can find this file in FusionDirectory include directory if argonaut plugin is installed */
+  require_once('jsonRPCClient.php');
+
+  /* Connection information. Fill peer_name with the name matching the certificate. */
+  $host       = 'https://localhost/fusiondirectory/jsonrpc.php';
+  $ca_file    = '/etc/ssl/certs/fd.pem';
+  $login      = 'fd-admin';
+  $password   = 'adminpwd';
+
+  /* DN of an existing user we can display and modify */
+  $userdn     = 'uid=bilbo,dc=opensides,dc=be';
+
+  $ssl_options = array(
+    'cafile'            => $ca_file,
+    'peer_name'         => 'localhost',
+    'verify_peer'       => TRUE,
+    'verify_peer_name'  => TRUE,
+  );
+
+  $http_options = array(
+    'timeout' => 10
+  );
+
+  try {
+    /* We create the connection object */
+    $client = new jsonRPCClient($host, $http_options, $ssl_options);
+
+    /* Then we need to login. Here we log in the default LDAP */
+    $session_id = $client->login(NULL, $login, $password);
+
+    /* Once we have a session ID, we can ask for the list of users */
+    $users  = $client->ls($session_id, 'user');
+
+    foreach ($users as $dn => $user) {
+      echo "$user ($dn)\n";
+    }
+  
+    /* We can get a user’s fields */
+    /* Doing the same thing with NULL as dn would create a user, if you provide all needed fields. */
+    $fields = $client->getfields($session_id, 'user', $userdn);
+
+    /* Change a value. We can pass an array for each tab, main one is 'user'. 
+      The array for each tab contains attribute ids and their new value. 
+      Attribute ids can be found in getfields, they are used as keys in the 'attrs' array of each section. 
+    */
+    $result = $client->setfields($session_id, 'user', $userdn, 
+    array(
+      'user' => array('description' => 'Modified by webservice')
+      )
+    );
+
+    if (isset($result['errors'])) {
+      foreach($result['errors'] as $error) {
+        print "Error: $error\n";
+      }
+    }
+
+  } catch (jsonRPCClient_RequestErrorException $e) {
+    die($e->getMessage());
+
+  } catch (jsonRPCClient_NetworkErrorException $e) {
+    die($e->getMessage());
+  }
+

source/coding/copyright.rst

+Headers for the files in FusionDirectory code
+=============================================
+
+Each file inside FusionDirectory code must have an header mentioning copyright and license
+
+The header should look like this
+
+.. code-block:: php
+
+  <?php
+  /*
+    This code is part of FusionDirectory (http://www.fusiondirectory.org/)
+    Copyright (C) 2017  FusionDirectory
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
+  */

source/coding/index.rst

@@ -6,3 +6,5 @@ Coding Standards
 
    sourcecode
    codingstandards
+   copyright
+

source/index.rst

@@ -18,6 +18,7 @@ Contents:
 
    coding/index
    pluginsystem/index
+   api/index
    schemas/index
    themes/index
    release/index