From 28317ed9ae956cd5994bda1a88c1ad058d54b676 Mon Sep 17 00:00:00 2001 From: rabuzarus <> Date: Sat, 26 Dec 2015 15:51:41 +0100 Subject: [PATCH 1/4] added databas schema to the help --- doc/Database.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/Home.md | 1 + doc/de/Home.md | 1 + 3 files changed, 63 insertions(+) create mode 100644 doc/Database.md diff --git a/doc/Database.md b/doc/Database.md new file mode 100644 index 000000000..2a509bef8 --- /dev/null +++ b/doc/Database.md @@ -0,0 +1,61 @@ +Database Tables +=============== + +* [Home](help) + +| Table | Description | +|------------------------------------------------------|--------------------------------------------------| +| [addon](help/database/db_addon) | registered plugins | +| [attach](help/database/db_attach) | file attachments | +| [auth_codes](help/database/db_auth_codes) | OAuth usage | +| [cache](help/database/db_cache) | OEmbed cache | +| [challenge](help/database/db_challenge) | | +| [clients](help/database/db_clients) | OAuth usage | +| [config](help/database/db_config) | main configuration storage | +| [contact](help/database/db_contact) | contact table | +| [conv](help/database/db_conv) | Diaspora private messages | +| [deliverq](help/database/db_deliverq) | | +| [dsprphotoq](help/database/db_dsprphotoq) | | +| [event](help/database/db_event) | Events | +| [fcontact](help/database/db_fcontact) | friend suggestion stuff | +| [ffinder](help/database/db_ffinder) | friend suggestion stuff | +| [fserver](help/database/db_fserver) | | +| [fsuggest](help/database/db_fsuggest) | friend suggestion stuff | +| [gcign](help/database/db_gcign) | contacts ignored by friend suggestions | +| [gcontact](help/database/db_gcontact) | | +| [glink](help/database/db_glink) | "friends of friends" linkages derived from poco | +| [group](help/database/db_group) | privacy groups, group info | +| [group_member](help/database/db_group_member) | privacy groups, member info | +| [gserver](help/database/db_gserver) | | +| [guid](help/database/db_guid) | | +| [hook](help/database/db_hook) | plugin hook registry | +| [intro](help/database/db_intro) | | +| [item](help/database/db_item) | all posts | +| [item_id](help/database/db_item_id) | other identifiers on other services for posts | +| [locks](help/database/db_locks) | | +| [mail](help/database/db_mail) | private messages | +| [mailacct](help/database/db_mailacct) | | +| [manage](help/database/db_manage) | table of accounts that can "su" each other | +| [notify](help/database/db_notify) | notifications | +| [notify-threads](help/database/db_notify-threads) | | +| [pconfig](help/database/db_pconfig) | personal (per user) configuration storage | +| [photo](help/database/db_photo) | photo storage | +| [poll](help/database/db_poll) | data for polls | +| [poll_result](help/database/db_poll_result) | data for poll elements | +| [profile](help/database/db_profile) | user profiles data | +| [profile_check](help/database/db_profile_check) | DFRN remote auth use | +| [push_subscriber](help/database/db_push_subscriber) | | +| [queue](help/database/db_queue) | | +| [register](help/database/db_register) | registrations requiring admin approval | +| [search](help/database/db_search) | | +| [session](help/database/db_session) | web session storage | +| [sign](help/database/db_sign) | Diaspora signatures | +| [spam](help/database/db_spam) | unfinished | +| [term](help/database/db_term) | item taxonomy (categories, tags, etc.) table | +| [test](help/database/db_test) | | +| [thread](help/database/db_thread) | | +| [tokens](help/database/db_tokens) | OAuth usage | +| [unique_contacts](help/database/db_unique_contacts) | | +| [user](help/database/db_user) | local user table | +| [userd](help/database/db_userd) | | +| [workerqueue](help/database/db_workerqueue) | | diff --git a/doc/Home.md b/doc/Home.md index b37c76417..b60debf42 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -46,6 +46,7 @@ Friendica Documentation and Resources * [Plugin Development](help/Plugins) * [Theme Development](help/themes) * [Smarty 3 Templates](help/smarty3-templates) +* [Database schema documantation](help/Database) * [Code - Reference(Doxygen generated - sets cookies)](doc/html/) **External Resources** diff --git a/doc/de/Home.md b/doc/de/Home.md index 44ebfc028..8a21e81c5 100644 --- a/doc/de/Home.md +++ b/doc/de/Home.md @@ -50,6 +50,7 @@ Friendica - Dokumentation und Ressourcen * [Plugin Development](help/Plugins) * [Theme Development](help/themes) * [Smarty 3 Templates](help/smarty3-templates) +* [Datenbank-Schema](help/Database) * [Code-Referenz (mit doxygen generiert - setzt Cookies)](doc/html/) **Externe Ressourcen** From 7530c950e3cf5379b9d7f675a31833497ae8d576 Mon Sep 17 00:00:00 2001 From: rabuzarus <> Date: Sat, 26 Dec 2015 16:06:38 +0100 Subject: [PATCH 2/4] help - make use of subfolders --- boot.php | 12 ++++++++++++ mod/help.php | 12 ++++++++++-- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/boot.php b/boot.php index bd2bee3ab..a51b7a42b 100644 --- a/boot.php +++ b/boot.php @@ -1960,3 +1960,15 @@ function current_load() { return max($load_arr); } + +// much better way of dealing with c-style args +function argc() { + return get_app()->argc; +} + +function argv($x) { + if(array_key_exists($x,get_app()->argv)) + return get_app()->argv[$x]; + + return ''; +} diff --git a/mod/help.php b/mod/help.php index 6d8fbb184..ebade07ea 100644 --- a/mod/help.php +++ b/mod/help.php @@ -27,8 +27,16 @@ function help_content(&$a) { $text = ''; if ($a->argc > 1) { - $text = load_doc_file('doc/' . $a->argv[1] . '.md'); - $a->page['title'] = t('Help:') . ' ' . str_replace('-', ' ', notags($a->argv[1])); + $path = ''; + for($x = 1; $x < argc(); $x ++) { + if(strlen($path)) + $path .= '/'; + $path .= argv($x); + } + $title = basename($path); + + $text = load_doc_file('doc/' . $path . '.md'); + $a->page['title'] = t('Help:') . ' ' . str_replace('-', ' ', notags($title)); } $home = load_doc_file('doc/Home.md'); if (!$text) { From 12f8b0630db68ace56ecc4e4134de870667bc072 Mon Sep 17 00:00:00 2001 From: rabuzarus <> Date: Mon, 28 Dec 2015 02:50:25 +0100 Subject: [PATCH 3/4] docu - add schema of each db table --- doc/Home.md | 2 +- doc/{Database.md => database.md} | 5 +- doc/database/db_addon.md | 17 +++++++ doc/database/db_attach.md | 22 +++++++++ doc/database/db_auth_codes.md | 14 ++++++ doc/database/db_cache.md | 11 +++++ doc/database/db_challenge.md | 13 +++++ doc/database/db_clients.md | 13 +++++ doc/database/db_config.md | 11 +++++ doc/database/db_contact.md | 72 +++++++++++++++++++++++++++ doc/database/db_conv.md | 15 ++++++ doc/database/db_deliverq.md | 12 +++++ doc/database/db_dsprphotoq.md | 11 +++++ doc/database/db_event.md | 26 ++++++++++ doc/database/db_fcontact.md | 23 +++++++++ doc/database/db_ffinder.md | 11 +++++ doc/database/db_fserver.md | 11 +++++ doc/database/db_fsuggest.md | 16 ++++++ doc/database/db_gcign.md | 10 ++++ doc/database/db_gcontact.md | 27 +++++++++++ doc/database/db_glink.md | 13 +++++ doc/database/db_group.md | 12 +++++ doc/database/db_group_member.md | 11 +++++ doc/database/db_gserver.md | 23 +++++++++ doc/database/db_guid.md | 12 +++++ doc/database/db_hook.md | 12 +++++ doc/database/db_intro.md | 18 +++++++ doc/database/db_item.md | 69 ++++++++++++++++++++++++++ doc/database/db_item_id.md | 12 +++++ doc/database/db_locks.md | 11 +++++ doc/database/db_mail.md | 24 +++++++++ doc/database/db_mailacct.md | 20 ++++++++ doc/database/db_manage.md | 10 ++++ doc/database/db_notify-threads.md | 12 +++++ doc/database/db_notify.md | 22 +++++++++ doc/database/db_pconfig.md | 12 +++++ doc/database/db_photo.md | 29 +++++++++++ doc/database/db_poll.md | 19 ++++++++ doc/database/db_poll_result.md | 10 ++++ doc/database/db_profile.md | 48 ++++++++++++++++++ doc/database/db_profile_check.md | 13 +++++ doc/database/db_push_subscriber.md | 10 ++++ doc/database/db_queue.md | 14 ++++++ doc/database/db_register.md | 13 +++++ doc/database/db_search.md | 10 ++++ doc/database/db_session.md | 11 +++++ doc/database/db_sign.md | 13 +++++ doc/database/db_spam.md | 13 +++++ doc/database/db_term.md | 19 ++++++++ doc/database/db_thread.md | 30 ++++++++++++ doc/database/db_tokens.md | 13 +++++ doc/database/db_unique_contacts.md | 14 ++++++ doc/database/db_user.md | 78 ++++++++++++++++++++++++++++++ doc/database/db_userd.md | 9 ++++ doc/database/db_workerqueue.md | 13 +++++ doc/de/Home.md | 2 +- 56 files changed, 1011 insertions(+), 5 deletions(-) rename doc/{Database.md => database.md} (94%) create mode 100644 doc/database/db_addon.md create mode 100644 doc/database/db_attach.md create mode 100644 doc/database/db_auth_codes.md create mode 100644 doc/database/db_cache.md create mode 100644 doc/database/db_challenge.md create mode 100644 doc/database/db_clients.md create mode 100644 doc/database/db_config.md create mode 100644 doc/database/db_contact.md create mode 100644 doc/database/db_conv.md create mode 100644 doc/database/db_deliverq.md create mode 100644 doc/database/db_dsprphotoq.md create mode 100644 doc/database/db_event.md create mode 100644 doc/database/db_fcontact.md create mode 100644 doc/database/db_ffinder.md create mode 100644 doc/database/db_fserver.md create mode 100644 doc/database/db_fsuggest.md create mode 100644 doc/database/db_gcign.md create mode 100644 doc/database/db_gcontact.md create mode 100644 doc/database/db_glink.md create mode 100644 doc/database/db_group.md create mode 100644 doc/database/db_group_member.md create mode 100644 doc/database/db_gserver.md create mode 100644 doc/database/db_guid.md create mode 100644 doc/database/db_hook.md create mode 100644 doc/database/db_intro.md create mode 100644 doc/database/db_item.md create mode 100644 doc/database/db_item_id.md create mode 100644 doc/database/db_locks.md create mode 100644 doc/database/db_mail.md create mode 100644 doc/database/db_mailacct.md create mode 100644 doc/database/db_manage.md create mode 100644 doc/database/db_notify-threads.md create mode 100644 doc/database/db_notify.md create mode 100644 doc/database/db_pconfig.md create mode 100644 doc/database/db_photo.md create mode 100644 doc/database/db_poll.md create mode 100644 doc/database/db_poll_result.md create mode 100644 doc/database/db_profile.md create mode 100644 doc/database/db_profile_check.md create mode 100644 doc/database/db_push_subscriber.md create mode 100644 doc/database/db_queue.md create mode 100644 doc/database/db_register.md create mode 100644 doc/database/db_search.md create mode 100644 doc/database/db_session.md create mode 100644 doc/database/db_sign.md create mode 100644 doc/database/db_spam.md create mode 100644 doc/database/db_term.md create mode 100644 doc/database/db_thread.md create mode 100644 doc/database/db_tokens.md create mode 100644 doc/database/db_unique_contacts.md create mode 100644 doc/database/db_user.md create mode 100644 doc/database/db_userd.md create mode 100644 doc/database/db_workerqueue.md diff --git a/doc/Home.md b/doc/Home.md index b60debf42..3b6442867 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -46,7 +46,7 @@ Friendica Documentation and Resources * [Plugin Development](help/Plugins) * [Theme Development](help/themes) * [Smarty 3 Templates](help/smarty3-templates) -* [Database schema documantation](help/Database) +* [Database schema documantation](help/database) * [Code - Reference(Doxygen generated - sets cookies)](doc/html/) **External Resources** diff --git a/doc/Database.md b/doc/database.md similarity index 94% rename from doc/Database.md rename to doc/database.md index 2a509bef8..1893f77d0 100644 --- a/doc/Database.md +++ b/doc/database.md @@ -13,7 +13,7 @@ Database Tables | [clients](help/database/db_clients) | OAuth usage | | [config](help/database/db_config) | main configuration storage | | [contact](help/database/db_contact) | contact table | -| [conv](help/database/db_conv) | Diaspora private messages | +| [conv](help/database/db_conv) | private messages | | [deliverq](help/database/db_deliverq) | | | [dsprphotoq](help/database/db_dsprphotoq) | | | [event](help/database/db_event) | Events | @@ -22,7 +22,7 @@ Database Tables | [fserver](help/database/db_fserver) | | | [fsuggest](help/database/db_fsuggest) | friend suggestion stuff | | [gcign](help/database/db_gcign) | contacts ignored by friend suggestions | -| [gcontact](help/database/db_gcontact) | | +| [gcontact](help/database/db_gcontact) | global contacts | | [glink](help/database/db_glink) | "friends of friends" linkages derived from poco | | [group](help/database/db_group) | privacy groups, group info | | [group_member](help/database/db_group_member) | privacy groups, member info | @@ -52,7 +52,6 @@ Database Tables | [sign](help/database/db_sign) | Diaspora signatures | | [spam](help/database/db_spam) | unfinished | | [term](help/database/db_term) | item taxonomy (categories, tags, etc.) table | -| [test](help/database/db_test) | | | [thread](help/database/db_thread) | | | [tokens](help/database/db_tokens) | OAuth usage | | [unique_contacts](help/database/db_unique_contacts) | | diff --git a/doc/database/db_addon.md b/doc/database/db_addon.md new file mode 100644 index 000000000..099abbf64 --- /dev/null +++ b/doc/database/db_addon.md @@ -0,0 +1,17 @@ +Table addon +=========== + +| Field | Description | Type | Null | Key | Default | Extra | +| ------------- | --------------------------------------------- | ---------- | ---- | --- | ------- | --------------- | +| id | | int(11) | NO | PRI | NULL | auto_increment | +| name | plugin base (file)name | char(255) | NO | | | | +| version | currently unused | char(255) | NO | | | | +| installed | currently always 1 | tinyint(1) | NO | | 0 | | +| hidden | currently unused | tinyint(1) | NO | | 0 | | +| timestamp | file timestamp to check for reloads | bigint(20) | NO | | 0 | | +| plugin_admin | 1 = has admin config, 0 = has no admin config | tinyint(1) | NO | | 0 | | + +Notes: +These are addons which have been enabled by the site administrator on the admin/plugin page + +Return to [database documentation](help/database) diff --git a/doc/database/db_attach.md b/doc/database/db_attach.md new file mode 100644 index 000000000..f47380cd9 --- /dev/null +++ b/doc/database/db_attach.md @@ -0,0 +1,22 @@ +Table attach +============ + +| Field | Description | Type | Null | Key | Default | Extra | +| ---------- | ------------------------------------------------------| ------------ | ---- | --- | ------------------- | --------------- | +| id | generated index | int(11) | NO | PRI | NULL | auto_increment | +| uid | user_id of owner | int(11) | NO | | 0 | | +| hash | hash | varchar(64) | NO | | | | +| filename | filename of original | varchar(255) | NO | | | | +| filetype | mimetype | varchar(64) | NO | | | | +| filesize | size in bytes | int(11) | NO | | 0 | | +| data | file data | longblob | NO | | NULL | | +| created | creation time | datetime | NO | | 0000-00-00 00:00:00 | | +| edited | last edit time | datetime | NO | | 0000-00-00 00:00:00 | | +| allow_cid | Access Control - list of allowed contact.id '<19><78> | mediumtext | NO | | NULL | | +| allow_gid | Access Control - list of allowed groups | mediumtext | NO | | NULL | | +| deny_cid | Access Control - list of denied contact.id | mediumtext | NO | | NULL | | +| deny_gid | Access Control - list of denied groups | mediumtext | NO | | NULL | | + +Notes: Permissions are surrounded by angle chars. e.g. <4> + +Return to [database documentation](help/database) diff --git a/doc/database/db_auth_codes.md b/doc/database/db_auth_codes.md new file mode 100644 index 000000000..1fec38500 --- /dev/null +++ b/doc/database/db_auth_codes.md @@ -0,0 +1,14 @@ +Table auth_codes +================ + +OAuth2 authorisation register - currently implemented but unused + +| Field | Description | Type | Null | Key | Default | Extra | +| ------------- | ----------- | ------------ | ---- | --- | ------- | ----- | +| id | | varchar(40) | NO | PRI | NULL | | +| client_id | | varchar(20) | NO | | | | +| redirect_uri | | varchar(200) | NO | | | | +| expires | | int(11) | NO | | 0 | | +| scope | | varchar(250) | NO | | | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_cache.md b/doc/database/db_cache.md new file mode 100644 index 000000000..333adaa2c --- /dev/null +++ b/doc/database/db_cache.md @@ -0,0 +1,11 @@ +Table cache +=========== + +| Field | Description | Type | Null | Key | Default | Extra | +| ------------ | ---------------------------------- | ------------ | ---- | --- | ------------------- | ----- | +| k | horizontal width + url or resource | varchar(255) | NO | PRI | NULL | | +| v | OEmbed response from site | text | NO | | NULL | | +| updated | datetime of cache insertion | datetime | NO | MUL | 0000-00-00 00:00:00 | | +| expire_mode | | int(11) | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_challenge.md b/doc/database/db_challenge.md new file mode 100644 index 000000000..aa7b263fd --- /dev/null +++ b/doc/database/db_challenge.md @@ -0,0 +1,13 @@ +Table challenge +=============== + +| Field | Description | Type | Null | Key | Default | Extra | +|-------------|------------------|------------------|------|-----|---------|----------------| +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| challenge | | varchar(255) | NO | | | | +| dfrn-id | | varchar(255) | NO | | | | +| expire | | int(11) | NO | | 0 | | +| type | | varchar(255) | NO | | | | +| last_update | | varchar(255) | NO | | | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_clients.md b/doc/database/db_clients.md new file mode 100644 index 000000000..228b45cc2 --- /dev/null +++ b/doc/database/db_clients.md @@ -0,0 +1,13 @@ +Table clients +============= + +| Field | Description | Type | Null | Key | Default | Extra | +| ------------- | ----------- | ------------ | ---- | --- | ------- | ----- | +| client_id | | varchar(20) | NO | PRI | NULL | | +| pw | | varchar(20) | NO | | | | +| redirect_uri | | varchar(200) | NO | | | | +| name | | text | YES | | NULL | | +| icon | | text | YES | | NULL | | +| uid | | int(11) | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_config.md b/doc/database/db_config.md new file mode 100644 index 000000000..6bcb4bcf8 --- /dev/null +++ b/doc/database/db_config.md @@ -0,0 +1,11 @@ +Table config +============ + +| Field | Description | Type | Null | Key | Default | Extra | +| ----- | ----------- | ---------------- | ---- | --- | ------- | --------------- | +| id | | int(10) unsigned | NO | PRI | NULL | auto_increment | +| cat | | char(255) | NO | MUL | | | +| k | | char(255) | NO | | | | +| v | | text | NO | | NULL | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_contact.md b/doc/database/db_contact.md new file mode 100644 index 000000000..2e3ebc313 --- /dev/null +++ b/doc/database/db_contact.md @@ -0,0 +1,72 @@ +Table contact +============= + +| Field | Description | Type | Null | Key | Default | Extra | +|---------------------------|-----------------------------------------------------------|--------------|------|-----|---------------------|----------------| +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| uid | user.id of the owner of this data | int(11) | NO | MUL | 0 | | +| created | | datetime | NO | | 0000-00-00 00:00:00 | | +| self | 1 if the contact is the user him/her self | tinyint(1) | NO | | 0 | | +| remote_self | | tinyint(1) | NO | | 0 | | +| rel | The kind of the relation between the user and the contact | tinyint(1) | NO | | 0 | | +| duplex | | tinyint(1) | NO | | 0 | | +| network | Network protocol of the contact | varchar(255) | NO | | | | +| name | Name that this contact is known by | varchar(255) | NO | | | | +| nick | Nick- and user name of the contact | varchar(255) | NO | | | | +| location | | varchar(255) | NO | | | | +| about | | text | NO | | NULL | | +| keywords | public keywords (interests) of the contact | text | NO | | NULL | | +| gender | | varchar(32) | NO | | | | +| attag | | varchar(255) | NO | | | | +| photo | Link to the profile photo of the contact | text | NO | | NULL | | +| thumb | Link to the profile photo (thumb size) | text | NO | | NULL | | +| micro | Link to the profile photo (micro size) | text | NO | | NULL | | +| site-pubkey | | text | NO | | NULL | | +| issued-id | | varchar(255) | NO | | | | +| dfrn-id | | varchar(255) | NO | | | | +| url | | varchar(255) | NO | | | | +| nurl | | varchar(255) | NO | | | | +| addr | | varchar(255) | NO | | | | +| alias | | varchar(255) | NO | | | | +| pubkey | RSA public key 4096 bit | text | NO | | NULL | | +| prvkey | RSA private key 4096 bit | text | NO | | NULL | | +| batch | | varchar(255) | NO | | | | +| request | | text | NO | | NULL | | +| notify | | text | NO | | NULL | | +| poll | | text | NO | | NULL | | +| confirm | | text | NO | | NULL | | +| poco | | text | NO | | NULL | | +| aes_allow | | tinyint(1) | NO | | 0 | | +| ret-aes | | tinyint(1) | NO | | 0 | | +| usehub | | tinyint(1) | NO | | 0 | | +| subhub | | tinyint(1) | NO | | 0 | | +| hub-verify | | varchar(255) | NO | | | | +| last-update | Date of the last try to update the contact info | datetime | NO | | 0000-00-00 00:00:00 | | +| success_update | Date of the last successful contact update | datetime | NO | | 0000-00-00 00:00:00 | | +| failure_update | Date of the last failed update | datetime | NO | | 0000-00-00 00:00:00 | | +| name-date | | datetime | NO | | 0000-00-00 00:00:00 | | +| uri-date | | datetime | NO | | 0000-00-00 00:00:00 | | +| avatar-date | | datetime | NO | | 0000-00-00 00:00:00 | | +| term-date | | datetime | NO | | 0000-00-00 00:00:00 | | +| last-item | date of the last post | datetime | NO | | 0000-00-00 00:00:00 | | +| priority | | tinyint(3) | NO | | 0 | | +| blocked | | tinyint(1) | NO | | 1 | | +| readonly | posts of the contact are readonly | tinyint(1) | NO | | 0 | | +| writable | | tinyint(1) | NO | | 0 | | +| forum | contact is a forum | tinyint(1) | NO | | 0 | | +| prv | contact is a private group | tinyint(1) | NO | | 0 | | +| hidden | | tinyint(1) | NO | | 0 | | +| archive | | tinyint(1) | NO | | 0 | | +| pending | | tinyint(1) | NO | | 1 | | +| rating | | tinyint(1) | NO | | 0 | | +| reason | | text | NO | | NULL | | +| closeness | | tinyint(2) | NO | | 99 | | +| info | | mediumtext | NO | | NULL | | +| profile-id | | int(11) | NO | | 0 | | +| bdyear | | varchar(4) | NO | | | | +| bd | | date | NO | | 0000-00-00 | | +| notify_new_posts | | tinyint(1) | NO | | 0 | | +| fetch_further_information | | tinyint(1) | NO | | 0 | | +| ffi_keyword_blacklist | | mediumtext | NO | | NULL | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_conv.md b/doc/database/db_conv.md new file mode 100644 index 000000000..f20074d61 --- /dev/null +++ b/doc/database/db_conv.md @@ -0,0 +1,15 @@ +Table conv +========== + +| Field | Description | Type | Null | Key | Default | Extra | +| ------- | ----------------------------------------- | ---------------- | ---- | --- | ------------------- | --------------- | +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| guid | A unique identifier for this conversation | varchar(64) | NO | | | | +| recips | sender_handle;recipient_handle | mediumtext | NO | | NULL | | +| uid | user_id of the owner of this data | int(11) | NO | MUL | 0 | | +| creator | handle of creator | varchar(255) | NO | | | | +| created | creation timestamp | datetime | NO | | 0000-00-00 00:00:00 | | +| updated | edited timestamp | datetime | NO | | 0000-00-00 00:00:00 | | +| subject | subject of initial message | mediumtext | NO | | NULL | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_deliverq.md b/doc/database/db_deliverq.md new file mode 100644 index 000000000..533589957 --- /dev/null +++ b/doc/database/db_deliverq.md @@ -0,0 +1,12 @@ +Table deliverq +============== + +| Field | Description | Type | Null | Key | Default | Extra | +|---------|------------------|------------------|------|-----|---------|----------------| +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| cmd | | varchar(32) | NO | | | | +| item | | int(11) | NO | | 0 | | +| contact | | int(11) | NO | | 0 | | + + +Return to [database documentation](help/database) diff --git a/doc/database/db_dsprphotoq.md b/doc/database/db_dsprphotoq.md new file mode 100644 index 000000000..6af4d030e --- /dev/null +++ b/doc/database/db_dsprphotoq.md @@ -0,0 +1,11 @@ +Table dsprphotoq +================ + +| Field | Description | Type | Null | Key | Default | Extra | +|---------|------------------|------------------|------|-----|---------|----------------| +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| uid | | int(11) | NO | | 0 | | +| msg | | mediumtext | NO | | NULL | | +| attempt | | tinyint(4) | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_event.md b/doc/database/db_event.md new file mode 100644 index 000000000..d45ddd206 --- /dev/null +++ b/doc/database/db_event.md @@ -0,0 +1,26 @@ +Table event +=========== + +| Field | Description | Type | Null | Key | Default | Extra | +| ---------- | ----------------------------------------------- -------| ------------------- | ---- | --- | ------------------- | --------------- | +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| uid | user_id of the owner of this data | int(11) | NO | MUL | 0 | | +| cid | contact_id (ID of the contact in contact table) | int(11) | NO | | 0 | | +| uri | | varchar(255) | NO | | | | +| created | creation time | datetime | NO | | 0000-00-00 00:00:00 | | +| edited | last edit time | datetime | NO | | 0000-00-00 00:00:00 | | +| start | event start time | datetime | NO | | 0000-00-00 00:00:00 | | +| finish | event end time | datetime | NO | | 0000-00-00 00:00:00 | | +| summary | short description or title of the event | text | NO | | NULL | | +| desc | event description | text | NO | | NULL | | +| location | event location | text | NO | | NULL | | +| type | event or birthday | varchar(255) | NO | | | | +| nofinish | if event does have no end this is 1 | tinyint(1) | NO | | 0 | | +| adjust | adjust to timezone of the recipient (0 or 1) | tinyint(1) | NO | | 1 | | +| ignore | 0 or 1 | tinyint(1) unsigned | NO | | 0 | | +| allow_cid | Access Control - list of allowed contact.id '<19><78>' | mediumtext | NO | | NULL | | +| allow_gid | Access Control - list of allowed groups | mediumtext | NO | | NULL | | +| deny_cid | Access Control - list of denied contact.id | mediumtext | NO | | NULL | | +| deny_gid | Access Control - list of denied groups | mediumtext | NO | | NULL | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_fcontact.md b/doc/database/db_fcontact.md new file mode 100644 index 000000000..e1cecbf87 --- /dev/null +++ b/doc/database/db_fcontact.md @@ -0,0 +1,23 @@ +Table fcontact +============== + +| Field | Description | Type | Null | Key | Default | Extra | +| -------- | ------------- | ---------------- | ---- | --- | ------------------- | --------------- | +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| url | | varchar(255) | NO | | | | +| name | | varchar(255) | NO | | | | +| photo | | varchar(255) | NO | | | | +| request | | varchar(255) | NO | | | | +| nick | | varchar(255) | NO | | | | +| addr | | varchar(255) | NO | MUL | | | +| batch | | varchar(255) | NO | | | | +| notify | | varchar(255) | NO | | | | +| poll | | varchar(255) | NO | | | | +| confirm | | varchar(255) | NO | | | | +| priority | | tinyint(1) | NO | | 0 | | +| network | | varchar(32) | NO | | | | +| alias | | varchar(255) | NO | | | | +| pubkey | | text | NO | | NULL | | +| updated | | datetime | NO | | 0000-00-00 00:00:00 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_ffinder.md b/doc/database/db_ffinder.md new file mode 100644 index 000000000..29fea20d5 --- /dev/null +++ b/doc/database/db_ffinder.md @@ -0,0 +1,11 @@ +Table ffinder +============= + +| Field | Description | Type | Null | Key | Default | Extra | +| ----- | ----------- | ---------------- | ---- | --- | ------- | --------------- | +| id | | int(10) unsigned | NO | PRI | NULL | auto_increment | +| uid | | int(10) unsigned | NO | | 0 | | +| cid | | int(10) unsigned | NO | | 0 | | +| fid | | int(10) unsigned | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_fserver.md b/doc/database/db_fserver.md new file mode 100644 index 000000000..535067627 --- /dev/null +++ b/doc/database/db_fserver.md @@ -0,0 +1,11 @@ +Table fserver +============= + +| Field | Description | Type | Null | Key | Default | Extra | +| ------- | ----------- | ------------ | ---- | --- | ------- | --------------- | +| id | | int(11) | NO | PRI | NULL | auto_increment | +| server | | varchar(255) | NO | MUL | | | +| posturl | | varchar(255) | NO | | | | +| key | | text | NO | | NULL | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_fsuggest.md b/doc/database/db_fsuggest.md new file mode 100644 index 000000000..b8751a478 --- /dev/null +++ b/doc/database/db_fsuggest.md @@ -0,0 +1,16 @@ +Table fsuggest +============== + +| Field | Description | Type | Null | Key | Default | Extra | +| ------- | ----------- | ------------ | ---- | --- | ------------------- | --------------- | +| id | | int(11) | NO | PRI | NULL | auto_increment | +| uid | | int(11) | NO | | 0 | | +| cid | | int(11) | NO | | 0 | | +| name | | varchar(255) | NO | | | | +| url | | varchar(255) | NO | | | | +| request | | varchar(255) | NO | | | | +| photo | | varchar(255) | NO | | | | +| note | | text | NO | | NULL | | +| created | | datetime | NO | | 0000-00-00 00:00:00 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_gcign.md b/doc/database/db_gcign.md new file mode 100644 index 000000000..9f5bbce76 --- /dev/null +++ b/doc/database/db_gcign.md @@ -0,0 +1,10 @@ +Table gcign +=========== + +| Field | Description | Type | Null | Key | Default | Extra | +| ----- | ------------------------------ | ------- | ---- | --- | ------- | --------------- | +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| uid | local user.id | int(11) | NO | MUL | 0 | | +| gcid | gcontact.id of ignored contact | int(11) | NO | MUL | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_gcontact.md b/doc/database/db_gcontact.md new file mode 100644 index 000000000..8e9de43c9 --- /dev/null +++ b/doc/database/db_gcontact.md @@ -0,0 +1,27 @@ +Table gcontact +============== + +| Field |Description | Type | Null | Key | Default | Extra | +|--------------|------------------------------------|------------------|------|-----|---------------------|----------------| +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| name | Name that this contact is known by | varchar(255) | NO | | | | +| nick | Nick- and user name of the contact | varchar(255) | NO | | | | +| url | Link to the contacts profile page | varchar(255) | NO | | | | +| nurl | | varchar(255) | NO | MUL | | | +| photo | Link to the profile photo | varchar(255) | NO | | | | +| connect | | varchar(255) | NO | | | | +| created | | datetime | NO | | 0000-00-00 00:00:00 | | +| updated | | datetime | YES | MUL | 0000-00-00 00:00:00 | | +| last_contact | | datetime | YES | | 0000-00-00 00:00:00 | | +| last_failure | | datetime | YES | | 0000-00-00 00:00:00 | | +| location | | varchar(255) | NO | | | | +| about | | text | NO | | NULL | | +| keywords | puplic keywords (interests) | text | NO | | NULL | | +| gender | | varchar(32) | NO | | | | +| community | 1 if contact is forum account | tinyint(1) | NO | | 0 | | +| network | social network protocol | varchar(255) | NO | | | | +| addr | | varchar(255) | NO | | | | +| generation | | tinyint(3) | NO | | 0 | | +| server_url | baseurl of the contacts server | varchar(255) | NO | | | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_glink.md b/doc/database/db_glink.md new file mode 100644 index 000000000..eb2f10bc6 --- /dev/null +++ b/doc/database/db_glink.md @@ -0,0 +1,13 @@ +Table glink +=========== + +| Field | Description | Type | Null | Key | Default | Extra | +|---------|------------------|------------------|------|-----|---------------------|----------------| +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| cid | | int(11) | NO | MUL | 0 | | +| uid | | int(11) | NO | | 0 | | +| gcid | | int(11) | NO | MUL | 0 | | +| zcid | | int(11) | NO | MUL | 0 | | +| updated | | datetime | NO | | 0000-00-00 00:00:00 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_group.md b/doc/database/db_group.md new file mode 100644 index 000000000..f27b9a75f --- /dev/null +++ b/doc/database/db_group.md @@ -0,0 +1,12 @@ +Table group +=========== + +| Field | Description | Type | Null | Key | Default | Extra | +| ------- | ------------------------------------------ | ---------------- | ---- | --- | ------- | --------------- | +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| uid | user.id owning this data | int(10) unsigned | NO | MUL | 0 | | +| visible | 1 indicates the member list is not private | tinyint(1) | NO | | 0 | | +| deleted | 1 indicates the group has been deleted | tinyint(1) | NO | | 0 | | +| name | human readable name of group | varchar(255) | NO | | | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_group_member.md b/doc/database/db_group_member.md new file mode 100644 index 000000000..f8a402ef6 --- /dev/null +++ b/doc/database/db_group_member.md @@ -0,0 +1,11 @@ +Table group_member +================== + +| Field | Description | Type | Null | Key | Default | Extra | +| ---------- | ----------------------------------------------------------- | ---------------- | ---- | --- | ------- | --------------- | +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| uid | user.id of the owner of this data | int(10) unsigned | NO | MUL | 0 | | +| gid | groups.id of the associated group | int(10) unsigned | NO | | 0 | | +| contact-id | contact.id of the member assigned to the associated group | int(10) unsigned | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_gserver.md b/doc/database/db_gserver.md new file mode 100644 index 000000000..b62b80272 --- /dev/null +++ b/doc/database/db_gserver.md @@ -0,0 +1,23 @@ +Table gserver +============= + +| Field | Description | Type | Null | Key | Default | Extra | +|-----------------|------------------|------------------|------|-----|---------------------|----------------| +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| url | | varchar(255) | NO | | | | +| nurl | | varchar(255) | NO | MUL | | | +| version | | varchar(255) | NO | | | | +| site_name | | varchar(255) | NO | | | | +| info | | text | NO | | NULL | | +| register_policy | | tinyint(1) | NO | | 0 | | +| poco | | varchar(255) | NO | | | | +| noscrape | | varchar(255) | NO | | | | +| network | | varchar(32) | NO | | | | +| platform | | varchar(255) | NO | | | | +| created | | datetime | NO | | 0000-00-00 00:00:00 | | +| last_poco_query | | datetime | YES | | 0000-00-00 00:00:00 | | +| last_contact | | datetime | YES | | 0000-00-00 00:00:00 | | +| last_failure | | datetime | YES | | 0000-00-00 00:00:00 | | + + +Return to [database documentation](help/database) diff --git a/doc/database/db_guid.md b/doc/database/db_guid.md new file mode 100644 index 000000000..f607597a2 --- /dev/null +++ b/doc/database/db_guid.md @@ -0,0 +1,12 @@ +Table guid +========== + +| Field | Description | Type | Null | Key | Default | Extra | +|---------|------------------|------------------|------|-----|---------|----------------| +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| guid | | varchar(255) | NO | MUL | | | +| plink | | varchar(255) | NO | MUL | | | +| uri | | varchar(255) | NO | MUL | | | +| network | | varchar(32) | NO | | | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_hook.md b/doc/database/db_hook.md new file mode 100644 index 000000000..06eb84a18 --- /dev/null +++ b/doc/database/db_hook.md @@ -0,0 +1,12 @@ +Table hook +========== + +| Field | Description | Type | Null | Key | Default | Extra | +| -------- | ---------------------------------------------------------------------------------------------------------- | ---------------- | ---- | --- | ------- | --------------- | +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| hook | name of hook | varchar(255) | NO | MUL | | | +| file | relative filename of hook handler | varchar(255) | NO | | | | +| function | function name of hook handler | varchar(255) | NO | | | | +| priority | not yet implemented - can be used to sort conflicts in hook handling by calling handlers in priority order | int(11) unsigned | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_intro.md b/doc/database/db_intro.md new file mode 100644 index 000000000..9eb68532c --- /dev/null +++ b/doc/database/db_intro.md @@ -0,0 +1,18 @@ +Table intro +=========== + +| Field | Description | Type | Null | Key | Default | Extra | +|------------|------------------|------------------|------|-----|---------------------|----------------| +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| uid | | int(10) unsigned | NO | | 0 | | +| fid | | int(11) | NO | | 0 | | +| contact-id | | int(11) | NO | | 0 | | +| knowyou | | tinyint(1) | NO | | 0 | | +| duplex | | tinyint(1) | NO | | 0 | | +| note | | text | NO | | NULL | | +| hash | | varchar(255) | NO | | | | +| datetime | | datetime | NO | | 0000-00-00 00:00:00 | | +| blocked | | tinyint(1) | NO | | 1 | | +| ignore | | tinyint(1) | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_item.md b/doc/database/db_item.md new file mode 100644 index 000000000..3ed986a78 --- /dev/null +++ b/doc/database/db_item.md @@ -0,0 +1,69 @@ +Table item +========== + +| Field | Description | Type | Null | Key | Default | Extra | +|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|------|-----|---------------------|----------------| +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| guid | A unique identifier for this item | varchar(255) | NO | MUL | | | +| uri | | varchar(255) | NO | MUL | | | +| uid | user.id which owns this copy of the item | int(10) unsigned | NO | MUL | 0 | | +| contact-id | contact.id | int(11) | NO | MUL | 0 | | +| type | | varchar(255) | NO | | | | +| wall | This item was posted to the wall of uid | tinyint(1) | NO | MUL | 0 | | +| gravity | | tinyint(1) | NO | | 0 | | +| parent | item.id of the parent to this item if it is a reply of some form; otherwise this must be set to the id of this item | int(10) unsigned | NO | MUL | 0 | | +| parent-uri | uri of the parent to this item | varchar(255) | NO | MUL | | | +| extid | | varchar(255 | NO | MUL | | | +| thr-parent | If the parent of this item is not the top-level item in the conversation, the uri of the immediate parent; otherwise set to parent-uri | varchar(255) | NO | | | | +| created | Creation timestamp. | datetime | NO | | 0000-00-00 00:00:00 | | +| edited | Date of last edit (default is created) | datetime | NO | | 0000-00-00 00:00:00 | | +| commented | Date of last comment/reply to this item | datetime | NO | | 0000-00-00 00:00:00 | | +| received | datetime | datetime | NO | | 0000-00-00 00:00:00 | | +| changed | Date that something in the conversation changed, indicating clients should fetch the conversation again | datetime | NO | | 0000-00-00 00:00:00 | | +| owner-name | Name of the owner of this item | varchar(255) | NO | | | | +| owner-link | Link to the profile page of the owner of this item | varchar(255) | NO | | | | +| owner-avatar | Link to the avatar picture of the owner of this item | varchar(255) | NO | | | | +| author-name | Name of the author of this item | varchar(255) | NO | | | | +| author-link | Link to the profile page of the author of this item | varchar(255) | NO | | | | +| author-avatar | Link to the avatar picture of the author of this item | varchar(255) | NO | | | | +| title | item title | varchar(255) | NO | | | | +| body | item body content | mediumtext | NO | | NULL | | +| app | application which generated this item | varchar(255) | NO | | | | +| verb | ActivityStreams verb | varchar(255) | NO | | | | +| object-type | ActivityStreams object type | varchar(255) | NO | | | | +| object | JSON encoded object structure unless it is an implied object (normal post) | text | NO | | NULL | | +| target-type | ActivityStreams target type if applicable (URI) | varchar(255) | NO | | | | +| target | JSON encoded target structure if used | text | NO | | NULL | | +| postopts | External post connectors add their network name to this comma-separated string to identify that they should be delivered to these networks during delivery | text | NO | | NULL | | +| plink | permalink or URL toa displayable copy of the message at its source | varchar(255) | NO | | | | +| resource-id | Used to link other tables to items, it identifies the linked resource (e.g. photo) and if set must also set resource_type | varchar(255) | NO | MUL | | | +| event-id | Used to link to the event.id | int(11) | NO | | 0 | | +| tag | | mediumtext | NO | | NULL | | +| attach | JSON structure representing attachments to this item | mediumtext | NO | | NULL | | +| inform | | mediumtext | NO | | NULL | | +| file | | mediumtext | NO | | NULL | | +| location | text location where this item originated | varchar(255) | NO | | | | +| coord | longitude/latitude pair representing location where this item originated | varchar(255) | NO | | | | +| allow_cid | Access Control - list of allowed contact.id '<19><78>' | mediumtext | NO | | NULL | | +| allow_gid | Access Control - list of allowed groups | mediumtext | NO | | NULL | | +| deny_cid | Access Control - list of denied contact.id | mediumtext | NO | | NULL | | +| deny_gid | Access Control - list of denied groups | mediumtext | NO | | NULL | | +| private | distribution is restricted | tinyint(1) | NO | | 0 | | +| pubmail | | tinyint(1) | NO | | 0 | | +| moderated | | tinyint(1) | NO | | 0 | | +| visible | | tinyint(1) | NO | | 0 | | +| spam | | tinyint(1) | NO | | 0 | | +| starred | item has been favourited | tinyint(1) | NO | | 0 | | +| bookmark | item has been bookmarked | tinyint(1) | NO | | 0 | | +| unseen | item has not been seen | tinyint(1) | NO | | 1 | | +| deleted | item has been deleted | tinyint(1) | NO | MUL | 0 | | +| origin | item originated at this site | tinyint(1) | NO | | 0 | | +| forum_mode | | tinyint(1) | NO | | 0 | | +| last-child | | tinyint(1) unsigned | NO | | 1 | | +| mention | The owner of this item was mentioned in it | tinyint(1) | NO | | 0 | | +| network | Network from where the item comes from | varchar(32) | NO | | | | +| rendered-hash | | varchar(32) | NO | | | | +| rendered-html | item.body converted to html | mediumtext | NO | | NULL | | +| global | | tinyint(1) | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_item_id.md b/doc/database/db_item_id.md new file mode 100644 index 000000000..c57861700 --- /dev/null +++ b/doc/database/db_item_id.md @@ -0,0 +1,12 @@ +Table item_id +============= + +| Field | Description | Type | Null | Key | Default | Extra | +| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ---- | --- | ------- | --------------- | +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| iid | item.id of the referenced item | int(11) | NO | MUL | 0 | | +| uid | user.id of the owner of this data | int(11) | NO | MUL | 0 | | +| sid | an additional identifier to attach or link to the referenced item (often used to store a message_id from another system in order to suppress duplicates) | varchar(255) | NO | MUL | | | +| service | the name or description of the service which generated this identifier | varchar(255) | NO | MUL | | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_locks.md b/doc/database/db_locks.md new file mode 100644 index 000000000..f9b93ff66 --- /dev/null +++ b/doc/database/db_locks.md @@ -0,0 +1,11 @@ +Table locks +=========== + +| Field | Description | Type | Null | Key | Default | Extra | +|---------|------------------|--------------|------|-----|---------------------|----------------| +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| name | | varchar(128) | NO | | | | +| locked | | tinyint(1) | NO | | 0 | | +| created | | datetime | YES | | 0000-00-00 00:00:00 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_mail.md b/doc/database/db_mail.md new file mode 100644 index 000000000..7047da96a --- /dev/null +++ b/doc/database/db_mail.md @@ -0,0 +1,24 @@ +Table mail +========== + +| Field | Description | Type | Null | Key | Default | Extra | +| ---------- | -------------------------------------------- | ---------------- | ---- | --- | ------------------- | --------------- | +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| uid | user.id of the owner of this data | int(10) unsigned | NO | MUL | 0 | | +| guid | A unique identifier for this private message | int(10) unsigned | NO | MUL | | | +| from-name | name of the sender | varchar(255) | NO | | | | +| from-photo | contact photo link of the sender | varchar(255) | NO | | | | +| from-url | profile linke of the sender | varchar(255) | NO | | | | +| contact-id | contact.id | varchar(255) | NO | | | | +| convid | conv.id | int(11) unsigned | NO | MUL | 0 | | +| title | | varchar(255) | NO | | | | +| body | | mediumtext | NO | | NULL | | +| seen | if message visited it is 1 | varchar(255) | NO | | 0 | | +| reply | | varchar(255) | NO | MUL | 0 | | +| replied | | varchar(255) | NO | | 0 | | +| unknown | if sender not in the contact table this is 1 | varchar(255) | NO | | 0 | | +| uri | | varchar(255) | NO | MUL | | | +| parent-uri | | varchar(255) | NO | MUL | | | +| created | creation time of the private message | datetime | NO | | 0000-00-00 00:00:00 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_mailacct.md b/doc/database/db_mailacct.md new file mode 100644 index 000000000..1c2deb815 --- /dev/null +++ b/doc/database/db_mailacct.md @@ -0,0 +1,20 @@ +Table mailacct +============== + +| Field | Description | Type | Null | Key | Default | Extra | +|--------------|------------------|--------------|------|-----|---------------------|----------------| +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| uid | | int(11) | NO | | 0 | | +| server | | varchar(255) | NO | | | | +| port | | int(11) | NO | | 0 | | +| ssltype | | varchar(16) | NO | | | | +| mailbox | | varchar(255) | NO | | | | +| user | | varchar(255) | NO | | | | +| pass | | text | NO | | NULL | | +| reply_to | | varchar(255) | NO | | | | +| action | | int(11) | NO | | 0 | | +| movetofolder | | varchar(255) | NO | | | | +| pubmail | | tinyint(1) | NO | | 0 | | +| last_check | | datetime | NO | | 0000-00-00 00:00:00 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_manage.md b/doc/database/db_manage.md new file mode 100644 index 000000000..4cfc1d0a1 --- /dev/null +++ b/doc/database/db_manage.md @@ -0,0 +1,10 @@ +Table manage +============ + +| Field | Description | Type | Null | Key | Default | Extra | +| ----- | ------------- | ------- | ---- | --- | ------- | --------------- | +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| uid | user.id | int(11) | NO | MUL | 0 | | +| mid | | int(11) | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_notify-threads.md b/doc/database/db_notify-threads.md new file mode 100644 index 000000000..5c196628d --- /dev/null +++ b/doc/database/db_notify-threads.md @@ -0,0 +1,12 @@ +Table notify-threads +==================== + +| Field | Description | Type | Null | Key | Default | Extra | +|--------------------|------------------|------------------|------|-----|---------|----------------| +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| notify-id | | int(11) | NO | | 0 | | +| master-parent-item | | int(10) unsigned | NO | MUL | 0 | | +| parent-item | | int(10) unsigned | NO | | 0 | | +| receiver-uid | | int(11) | NO | MUL | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_notify.md b/doc/database/db_notify.md new file mode 100644 index 000000000..5ef2aa7eb --- /dev/null +++ b/doc/database/db_notify.md @@ -0,0 +1,22 @@ +Table notify +============ + +| Field | Description | Type | Null | Key | Default | Extra | +| ------ | --------------------------------- | ------------ | ---- | --- | ------------------- | --------------- | +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| hash | | varchar(64) | NO | | | | +| type | | int(11) | NO | | 0 | | +| name | | varchar(255) | NO | | | | +| url | | varchar(255) | NO | | | | +| photo | | varchar(255) | NO | | | | +| date | | datetime | NO | | 0000-00-00 00:00:00 | | +| msg | | mediumtext | NO | | NULL | | +| uid | user.id of the owner of this data | int(11) | NO | MUL | 0 | | +| link | | varchar(255) | NO | | | | +| parent | | int(11) | NO | | 0 | | +| seen | | tinyint(1) | NO | | 0 | | +| verb | | varchar(255) | NO | | | | +| otype | | varchar(16) | NO | | | | +| iid | item.id | int(11) | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_pconfig.md b/doc/database/db_pconfig.md new file mode 100644 index 000000000..a4ed10a35 --- /dev/null +++ b/doc/database/db_pconfig.md @@ -0,0 +1,12 @@ +Table pconfic +============= + +| Field | Description | Type | Null | Key | Default | Extra | +|-------|-------------|------------|------|-----|---------|----------------| +| id | | int(11) | NO | PRI | NULL | auto_increment | +| uid | | int(11) | NO | MUL | 0 | | +| cat | | char(255) | NO | | | | +| k | | char(255) | NO | | | | +| v | | mediumtext | NO | | NULL | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_photo.md b/doc/database/db_photo.md new file mode 100644 index 000000000..2d5bf0938 --- /dev/null +++ b/doc/database/db_photo.md @@ -0,0 +1,29 @@ +Table photo +=========== + +| Field | Description | Type | Null | Key | Default | Extra | +| ----------- | ------------------------------------------------------ | ---------------- | ---- | --- | ------------------- | --------------- | +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| uid | user.id of the owner of this data | int(10) unsigned | NO | MUL | 0 | | +| contact-id | contact.id | int(10) unsigned | NO | | 0 | | +| guid | A unique identifier for this photo | varchar(64) | NO | MUL | | | +| resource-id | | varchar(255) | NO | MUL | | | +| created | creation date | datetime | NO | | 0000-00-00 00:00:00 | | +| edited | last edited date | datetime | NO | | 0000-00-00 00:00:00 | | +| title | | varchar(255) | NO | | | | +| desc | | text | NO | | NULL | | +| album | The name of the album to which the photo belongs | varchar(255) | NO | | | | +| filename | | varchar(255) | NO | | | | +| type | image type | varchar(128) | NO | | image/jpeg | | +| height | | smallint(6) | NO | | 0 | | +| width | | smallint(6) | NO | | 0 | | +| size | | int(10) unsigned | NO | | 0 | | +| data | | mediumblob | NO | | NULL | | +| scale | | tinyint(3) | NO | | 0 | | +| profile | | tinyint(1) | NO | | 0 | | +| allow_cid | Access Control - list of allowed contact.id '<19><78>' | mediumtext | NO | | NULL | | +| allow_gid | Access Control - list of allowed groups | mediumtext | NO | | NULL | | +| deny_cid | Access Control - list of denied contact.id | mediumtext | NO | | NULL | | +| deny_gid | Access Control - list of denied groups | mediumtext | NO | | NULL | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_poll.md b/doc/database/db_poll.md new file mode 100644 index 000000000..fd89b345c --- /dev/null +++ b/doc/database/db_poll.md @@ -0,0 +1,19 @@ +Table poll +========== + +| Field | Description | Type | Null | Key | Default | Extra | +|-------|-------------|------------|------|-----|---------|----------------| +| id | | int(11) | NO | PRI | NULL | auto_increment | +| uid | | int(11) | NO | MUL | 0 | | +| q0 | | mediumtext | NO | | NULL | | +| q1 | | mediumtext | NO | | NULL | | +| q2 | | mediumtext | NO | | NULL | | +| q3 | | mediumtext | NO | | NULL | | +| q4 | | mediumtext | NO | | NULL | | +| q5 | | mediumtext | NO | | NULL | | +| q6 | | mediumtext | NO | | NULL | | +| q7 | | mediumtext | NO | | NULL | | +| q8 | | mediumtext | NO | | NULL | | +| q9 | | mediumtext | NO | | NULL | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_poll_result.md b/doc/database/db_poll_result.md new file mode 100644 index 000000000..5a732d0ad --- /dev/null +++ b/doc/database/db_poll_result.md @@ -0,0 +1,10 @@ +Table poll_result +================= + +| Field | Description | Type | Null | Key | Default | Extra | +|---------|------------------|---------|------|-----|---------|----------------| +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| poll_id | | int(11) | NO | MUL | 0 | | +| choice | | int(11) | NO | MUL | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_profile.md b/doc/database/db_profile.md new file mode 100644 index 000000000..fba351a2d --- /dev/null +++ b/doc/database/db_profile.md @@ -0,0 +1,48 @@ +Table profile +============= + +| Field | Description | Type | Null | Key | Default | Extra | +|--------------|-----------------------------------------------|--------------|------|-----|---------------------|----------------| +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| uid | user.id of the owner of this data | int(11) | NO | | 0 | | +| profile-name | Name of the profile | varchar(255) | NO | | | | +| is-default | Mark this profile as default profile | tinyint(1) | NO | | 0 | | +| hide-friends | Hide friend list from viewers of this profile | tinyint(1) | NO | | 0 | | +| name | | varchar(255) | NO | | | | +| pdesc | Title or description | varchar(255) | NO | | | | +| dob | Day of birth | varchar(32) | NO | | 0000-00-00 | | +| address | | varchar(255) | NO | | | | +| locality | | varchar(255) | NO | | | | +| region | | varchar(255) | NO | | | | +| postal-code | | varchar(32) | NO | | | | +| country-name | | varchar(255) | NO | | | | +| hometown | | varchar(255) | NO | MUL | | | +| gender | | varchar(32) | NO | | | | +| marital | | varchar(255) | NO | | | | +| with | | text | NO | | NULL | | +| howlong | | datetime | NO | | 0000-00-00 00:00:00 | | +| sexual | | varchar(255) | NO | | | | +| politic | | varchar(255) | NO | | | | +| religion | | varchar(255) | NO | | | | +| pub_keywords | | text | NO | | NULL | | +| prv_keywords | | text | NO | | NULL | | +| likes | | text | NO | | NULL | | +| dislikes | | text | NO | | NULL | | +| about | | text | NO | | NULL | | +| summary | | varchar(255) | NO | | | | +| music | | text | NO | | NULL | | +| book | | text | NO | | NULL | | +| tv | | text | NO | | NULL | | +| film | | text | NO | | NULL | | +| interest | | text | NO | | NULL | | +| romance | | text | NO | | NULL | | +| work | | text | NO | | NULL | | +| education | | text | NO | | NULL | | +| contact | | text | NO | | NULL | | +| homepage | | varchar(255) | NO | | | | +| photo | | varchar(255) | NO | | | | +| thumb | | varchar(255) | NO | | | | +| publish | publish default profile in local directory | tinyint(1) | NO | | 0 | | +| net-publish | publish profile in global directory | tinyint(1) | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_profile_check.md b/doc/database/db_profile_check.md new file mode 100644 index 000000000..411da06d3 --- /dev/null +++ b/doc/database/db_profile_check.md @@ -0,0 +1,13 @@ +Table profile_check +=================== + +| Field | Description | Type | Null | Key | Default | Extra | +| -------- | ------------- | ---------------- | ---- | --- | ------- | --------------- | +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| uid | user.id | int(10) unsigned | NO | | 0 | | +| cid | contact.id | int(10) unsigned | NO | | 0 | | +| dfrn_id | | varchar(255) | NO | | | | +| sec | | varchar(255) | NO | | 0 | | +| expire | | int(11) | NO | | NULL | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_push_subscriber.md b/doc/database/db_push_subscriber.md new file mode 100644 index 000000000..b766ccb46 --- /dev/null +++ b/doc/database/db_push_subscriber.md @@ -0,0 +1,10 @@ +Table push_subscriber +===================== + +| Field | Description | Type | Null | Key | Default | Extra | +|---------|------------------|---------|------|-----|---------|----------------| +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| poll_id | | int(11) | NO | MUL | 0 | | +| choice | | int(11) | NO | MUL | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_queue.md b/doc/database/db_queue.md new file mode 100644 index 000000000..44bb69c2e --- /dev/null +++ b/doc/database/db_queue.md @@ -0,0 +1,14 @@ +Table queue +=========== + +| Field | Description | Type | Null | Key | Default | Extra | +|---------|------------------|-------------|------|-----|---------------------|----------------| +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| cid | | int(11) | NO | MUL | 0 | | +| network | | varchar(32) | NO | MUL | | | +| created | | datetime | NO | MUL | 0000-00-00 00:00:00 | | +| last | | datetime | NO | MUL | 0000-00-00 00:00:00 | | +| content | | mediumtext | NO | | NULL | | +| batch | | tinyint(1) | NO | MUL | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_register.md b/doc/database/db_register.md new file mode 100644 index 000000000..ac2769b90 --- /dev/null +++ b/doc/database/db_register.md @@ -0,0 +1,13 @@ +Table register +============== + +| Field | Description | Type | Null | Key | Default | Extra | +| -------- | ------------- | ---------------- | ---- | --- | ------------------- | --------------- | +| id | sequential ID | int(11) unsigned | NO | PRI | NULL | auto_increment | +| hash | | varchar(255) | NO | | | | +| created | | datetime | NO | | 0000-00-00 00:00:00 | | +| uid | user.id | int(11) unsigned | NO | | | | +| password | | varchar(255) | NO | | | | +| language | | varchar(16) | NO | | | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_search.md b/doc/database/db_search.md new file mode 100644 index 000000000..63d0a46b4 --- /dev/null +++ b/doc/database/db_search.md @@ -0,0 +1,10 @@ +Table search +============ + +| Field | Description | Type | Null | Key | Default | Extra | +|-------|------------------|--------------|------|-----|---------|----------------| +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| uid | | int(11) | NO | MUL | 0 | | +| term | | varchar(255) | NO | MUL | | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_session.md b/doc/database/db_session.md new file mode 100644 index 000000000..1e87c24d0 --- /dev/null +++ b/doc/database/db_session.md @@ -0,0 +1,11 @@ +Table session +============= + +| Field | Description | Type | Null | Key | Default | Extra | +| ------ | ------------- | ------------------- | ---- | --- | ------- | --------------- | +| id | sequential ID | bigint(20) unsigned | NO | PRI | NULL | auto_increment | +| sid | | varchar(255) | NO | MUL | | | +| data | | text | NO | | NULL | | +| expire | | int(10) unsigned | NO | MUL | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_sign.md b/doc/database/db_sign.md new file mode 100644 index 000000000..8de59ac67 --- /dev/null +++ b/doc/database/db_sign.md @@ -0,0 +1,13 @@ +Table sign +========== + +| Field | Description | Type | Null | Key | Default | Extra | +| ------------ | ------------- | ---------------- | ---- | --- | ------- | --------------- | +| id | sequential ID | int(10) unsigned | NO | PRI | NULL | auto_increment | +| iid | item.id | int(10) unsigned | NO | MUL | 0 | | +| retract_iid | | int(10) unsigned | NO | MUL | 0 | | +| signed_text | | mediumtext | NO | | NULL | | +| signature | | text | NO | | NULL | | +| signer | | varchar(255) | NO | | | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_spam.md b/doc/database/db_spam.md new file mode 100644 index 000000000..f1428a682 --- /dev/null +++ b/doc/database/db_spam.md @@ -0,0 +1,13 @@ +Table spam +========== + +| Field | Description | Type | Null | Key | Default | Extra | +| ----- | ----------- | ------------ | ---- | --- | ------------------- | --------------- | +| id | | int(11) | NO | PRI | NULL | auto_increment | +| uid | | int(11) | NO | MUL | 0 | | +| spam | | int(11) | NO | MUL | 0 | | +| ham | | int(11) | NO | MUL | 0 | | +| term | | varchar(255) | NO | MUL | | | +| date | | datetime | NO | | 0000-00-00 00:00:00 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_term.md b/doc/database/db_term.md new file mode 100644 index 000000000..0240685a0 --- /dev/null +++ b/doc/database/db_term.md @@ -0,0 +1,19 @@ +Table term +========== + +| Field | Description | Type | Null | Key | Default | Extra | +|----------| ------------- |---------------------|------|-----|---------------------|----------------| +| tid | | int(10) unsigned | NO | PRI | NULL | auto_increment | +| oid | | int(10) unsigned | NO | MUL | 0 | | +| otype | | tinyint(3) unsigned | NO | MUL | 0 | | +| type | | tinyint(3) unsigned | NO | MUL | 0 | | +| term | | varchar(255) | NO | | | | +| url | | varchar(255) | NO | | | | +| aid | | int(10) unsigned | NO | | 0 | | +| uid | | int(10) unsigned | NO | MUL | 0 | | +| guid | | varchar(255) | NO | MUL | | | +| created | | datetime | NO | | 0000-00-00 00:00:00 | | +| received | | datetime | NO | | 0000-00-00 00:00:00 | | +| global | | tinyint(1) | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_thread.md b/doc/database/db_thread.md new file mode 100644 index 000000000..78af5cb37 --- /dev/null +++ b/doc/database/db_thread.md @@ -0,0 +1,30 @@ +Table thread +============ + +| Field | Description | Type | Null | Key | Default | Extra | +|------------|------------------|------------------|------|-----|---------------------|-------| +| iid | sequential ID | int(10) unsigned | NO | PRI | 0 | | +| uid | | int(10) unsigned | NO | MUL | 0 | | +| contact-id | | int(11) unsigned | NO | | 0 | | +| created | | datetime | NO | MUL | 0000-00-00 00:00:00 | | +| edited | | datetime | NO | | 0000-00-00 00:00:00 | | +| commented | | datetime | NO | MUL | 0000-00-00 00:00:00 | | +| received | | datetime | NO | | 0000-00-00 00:00:00 | | +| changed | | datetime | NO | | 0000-00-00 00:00:00 | | +| wall | | tinyint(1) | NO | MUL | 0 | | +| private | | tinyint(1) | NO | | 0 | | +| pubmail | | tinyint(1) | NO | | 0 | | +| moderated | | tinyint(1) | NO | | 0 | | +| visible | | tinyint(1) | NO | | 0 | | +| spam | | tinyint(1) | NO | | 0 | | +| starred | | tinyint(1) | NO | | 0 | | +| ignored | | tinyint(1) | NO | | 0 | | +| bookmark | | tinyint(1) | NO | | 0 | | +| unseen | | tinyint(1) | NO | | 1 | | +| deleted | | tinyint(1) | NO | | 0 | | +| origin | | tinyint(1) | NO | | 0 | | +| forum_mode | | tinyint(1) | NO | | 0 | | +| mention | | tinyint(1) | NO | | 0 | | +| network | | varchar(32) | NO | | | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_tokens.md b/doc/database/db_tokens.md new file mode 100644 index 000000000..3b3778d68 --- /dev/null +++ b/doc/database/db_tokens.md @@ -0,0 +1,13 @@ +Table tokens +============ + +| Field | Description | Type | Null | Key | Default | Extra | +| ---------- | ----------- | ------------ | ---- | --- | ------- | ----- | +| id | | varchar(40) | NO | PRI | NULL | | +| secret | | text | NO | | NULL | | +| client_id | | varchar(20) | NO | | | | +| expires | | int(11) | NO | | 0 | | +| scope | | varchar(200) | NO | | | | +| uid | | int(11) | NO | | 0 | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_unique_contacts.md b/doc/database/db_unique_contacts.md new file mode 100644 index 000000000..491da6aac --- /dev/null +++ b/doc/database/db_unique_contacts.md @@ -0,0 +1,14 @@ +Table unique_contacts +===================== + +| Field | Description | Type | Null | Key | Default | Extra | +|----------|------------------|--------------|------|-----|---------|----------------| +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| url | | varchar(255) | NO | MUL | | | +| nick | | varchar(255) | NO | | | | +| name | | varchar(255) | NO | | | | +| avatar | | varchar(255) | NO | | | | +| location | | varchar(255) | NO | | | | +| about | | text | NO | | NULL | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_user.md b/doc/database/db_user.md new file mode 100644 index 000000000..21ca211d7 --- /dev/null +++ b/doc/database/db_user.md @@ -0,0 +1,78 @@ +Table user +========== + +| Field | Description | Type | Null | Key | Default | Extra | +|--------------------------|-----------------------------------------------------------------------------------------|---------------------|------|-----|---------------------|----------------| +| uid | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| guid | A unique identifier for this user | varchar(64) | NO | | | | +| username | Name that this user is known by | varchar(255) | NO | | | | +| password | encrypted password | varchar(255) | NO | | | | +| nickname | nick- and user name | varchar(255) | NO | MUL | | | +| email | the users email address | varchar(255) | NO | | | | +| openid | | varchar(255) | NO | | | | +| timezone | PHP-legal timezone | varchar(128) | NO | | | | +| language | default language | varchar(32) | NO | | en | | +| register_date | timestamp of registration | datetime | NO | | 0000-00-00 00:00:00 | | +| login_date | timestamp of last login | datetime | NO | | 0000-00-00 00:00:00 | | +| default-location | Default for item.location | varchar(255) | NO | | | | +| allow_location | 1 allows to display the location | tinyint(1) | NO | | 0 | | +| theme | user theme preference | varchar(255) | NO | | | | +| pubkey | RSA public key 4096 bit | text | NO | | NULL | | +| prvkey | RSA private key 4096 bit | text | NO | | NULL | | +| spubkey | | text | NO | | NULL | | +| sprvkey | | text | NO | | NULL | | +| verified | user is verified through email | tinyint(1) unsigned | NO | | 0 | | +| blocked | 1 for user is blocked | tinyint(1) unsigned | NO | | 0 | | +| blockwall | Prohibit contacts to post to the profile page of the user | tinyint(1) unsigned | NO | | 0 | | +| hidewall | Hide profile details from unkown viewers | tinyint(1) unsigned | NO | | 0 | | +| blocktags | Prohibit contacts to tag the post of this user | tinyint(1) unsigned | NO | | 0 | | +| unkmail | Permit unknown people to send private mails to this user | tinyint(1) | NO | | 0 | | +| cntunkmail | | int(11) | NO | | 10 | | +| notify-flags | email notification options | int(11) unsigned | NO | | 65535 | | +| page-flags | page/profile type | int(11) unsigned | NO | | 0 | | +| prvnets | | tinyint(1) | NO | | 0 | | +| pwdreset | | varchar(255) | NO | | | | +| maxreq | | int(11) | NO | | 10 | | +| expire | | int(11) unsigned | NO | | 0 | | +| account_removed | if 1 the account is removed | tinyint(1) | NO | | 0 | | +| account_expired | | tinyint(1) | NO | | 0 | | +| account_expires_on | timestamp when account expires and will be deleted | datetime | NO | | 0000-00-00 00:00:00 | | +| expire_notification_sent | timestamp of last warning of account expiration | datetime | NO | | 0000-00-00 00:00:00 | | +| service_class | service class for this account, determines what if any limits/restrictions are in place | varchar(32) | NO | | | | +| def_gid | | int(11) | NO | | 0 | | +| allow_cid | default permission for this user | mediumtext | NO | | NULL | | +| allow_gid | default permission for this user | mediumtext | NO | | NULL | | +| deny_cid | default permission for this user | mediumtext | NO | | NULL | | +| deny_gid | default permission for this user | mediumtext | NO | | NULL | | +| openidserver | | text | NO | | NULL | | + +``` +/** +* page-flags +*/ +define ( 'PAGE_NORMAL', 0 ); +define ( 'PAGE_SOAPBOX', 1 ); +define ( 'PAGE_COMMUNITY', 2 ); +define ( 'PAGE_FREELOVE', 3 ); +define ( 'PAGE_BLOG', 4 ); +define ( 'PAGE_PRVGROUP', 5 ); + +/** +* notify-flags +*/ +define ( 'NOTIFY_INTRO', 0x0001 ); +define ( 'NOTIFY_CONFIRM', 0x0002 ); +define ( 'NOTIFY_WALL', 0x0004 ); +define ( 'NOTIFY_COMMENT', 0x0008 ); +define ( 'NOTIFY_MAIL', 0x0010 ); +define ( 'NOTIFY_SUGGEST', 0x0020 ); +define ( 'NOTIFY_PROFILE', 0x0040 ); +define ( 'NOTIFY_TAGSELF', 0x0080 ); +define ( 'NOTIFY_TAGSHARE', 0x0100 ); +define ( 'NOTIFY_POKE', 0x0200 ); +define ( 'NOTIFY_SHARE', 0x0400 ); + +define ( 'NOTIFY_SYSTEM', 0x8000 ); +``` + +Return to [database documentation](help/database) diff --git a/doc/database/db_userd.md b/doc/database/db_userd.md new file mode 100644 index 000000000..80e308475 --- /dev/null +++ b/doc/database/db_userd.md @@ -0,0 +1,9 @@ +Table userd +=========== + +| Field | Description | Type | Null | Key | Default | Extra | +|----------|------------------|--------------|------|-----|---------|----------------| +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| username | | varchar(255) | NO | MUL | NULL | | + +Return to [database documentation](help/database) diff --git a/doc/database/db_workerqueue.md b/doc/database/db_workerqueue.md new file mode 100644 index 000000000..b1f5245ae --- /dev/null +++ b/doc/database/db_workerqueue.md @@ -0,0 +1,13 @@ +Table workerqueue +================= + +| Field | Description | Type | Null | Key | Default | Extra | +|-----------|------------------|---------------------|------|-----|---------------------|----------------| +| id | sequential ID | int(11) | NO | PRI | NULL | auto_increment | +| parameter | | text | NO | | NULL | | +| priority | | tinyint(3) unsigned | NO | | 0 | | +| created | | datetime | NO | MUL | 0000-00-00 00:00:00 | | +| pid | | int(11) | NO | | 0 | | +| executed | | datetime | NO | | 0000-00-00 00:00:00 | | + +Return to [database documentation](help/database) diff --git a/doc/de/Home.md b/doc/de/Home.md index 8a21e81c5..365e18cb3 100644 --- a/doc/de/Home.md +++ b/doc/de/Home.md @@ -50,7 +50,7 @@ Friendica - Dokumentation und Ressourcen * [Plugin Development](help/Plugins) * [Theme Development](help/themes) * [Smarty 3 Templates](help/smarty3-templates) -* [Datenbank-Schema](help/Database) +* [Datenbank-Schema](help/database) * [Code-Referenz (mit doxygen generiert - setzt Cookies)](doc/html/) **Externe Ressourcen** From 038611bcb46c607851e04dcde813be012db5efb7 Mon Sep 17 00:00:00 2001 From: rabuzarus <> Date: Mon, 28 Dec 2015 03:17:55 +0100 Subject: [PATCH 4/4] add documentation --- boot.php | 12 +++++++++++- mod/help.php | 2 ++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/boot.php b/boot.php index a51b7a42b..4e6c9cf21 100644 --- a/boot.php +++ b/boot.php @@ -1961,11 +1961,21 @@ function current_load() { return max($load_arr); } -// much better way of dealing with c-style args +/** + * @brief get c-style args + * + * @return int + */ function argc() { return get_app()->argc; } +/** + * @brief Returns the value of a argv key + * + * @param int $x argv key + * @return string Value of the argv key + */ function argv($x) { if(array_key_exists($x,get_app()->argv)) return get_app()->argv[$x]; diff --git a/mod/help.php b/mod/help.php index ebade07ea..974577876 100644 --- a/mod/help.php +++ b/mod/help.php @@ -28,6 +28,8 @@ function help_content(&$a) { if ($a->argc > 1) { $path = ''; + // looping through the argv keys bigger than 0 to build + // a path relative to /help for($x = 1; $x < argc(); $x ++) { if(strlen($path)) $path .= '/';