From af4f162f2375e6dbd84f96b26c81497eea461fc3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marc=20W=C3=A4ckerlin?= <marc@mrw.sh>
Date: Thu, 5 Nov 2015 16:01:45 +0000
Subject: [PATCH] documentation added to tables

---
 ChangeLog             |  8 ++++++++
 html/messagetable.php | 24 +++++++++++++++++++++++-
 html/usertable.php    | 14 +++++++++++++-
 3 files changed, 44 insertions(+), 2 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 187b274..4391ecb 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2015-11-05 13:24  marc
+
+	* ChangeLog, bootstrap.sh,
+	  cordova/platforms/android/AndroidManifest.xml,
+	  cordova/platforms/android/res/xml/config.xml, debian,
+	  debian/control.in, makefile.am, scripts/safechat-install.sh:
+	  build in docker successful
+
 2015-11-05 12:53  marc
 
 	* bootstrap.sh, debian, debian/changelog.in, debian/compat,
diff --git a/html/messagetable.php b/html/messagetable.php
index 49aeb24..76d750e 100644
--- a/html/messagetable.php
+++ b/html/messagetable.php
@@ -23,7 +23,29 @@
 
 require_once("opendb.php");
 try {
-  $db->query('create table if not exists message (id int primary key not null auto_increment, time timestamp default current_timestamp, user varchar(50) not null, msg longtext not null, foreign key (user) references user(name) on delete cascade on update cascade) character set utf8 engine=innodb;');
+  $query = <<<EOD
+    create table if not exists
+      message (
+        id
+          int primary key not null auto_increment
+          comment "id of the message, it is used in the client to check if a message has already been downloaded or not",
+        time
+          timestamp default current_timestamp
+          comment "time when the message has been stored on the server",
+        user
+          varchar(50) not null
+          comment "name of the user that sent the message",
+        msg
+          longtext not null
+          comment "message content, must be armored gnupg encrypted format",
+        foreign key (user)
+          references user(name)
+          on delete cascade
+          on update cascade
+      ) character set utf8 engine=innodb
+        comment="table to hold all messages for later download by the receiver";
+EOD;
+  $db->query($query);
   $db->query('set global max_allowed_packet=1000000000');
   $db->query('set global net_buffer_length=1000000');
 } catch (Exception $e) {
diff --git a/html/usertable.php b/html/usertable.php
index b106044..553a362 100644
--- a/html/usertable.php
+++ b/html/usertable.php
@@ -24,7 +24,19 @@
 
 require_once("opendb.php");
 try {
-  $db->query('create table if not exists user (name varchar(50) not null primary key, pubkey text not null) character set utf8 engine=innodb;');
+  $query = <<<EOD
+    create table if not exists
+      user (
+          name
+            varchar(50) not null primary key
+            comment "unique name of the user",
+          pubkey
+            text not null
+            comment "armored gnupg public key of the user"
+      ) character set utf8 engine=innodb
+        comment="list of all registered users and their public keys";
+EOD;
+  $db->query($query);
 } catch (Exception $e) {
   error('database error on server');
 }