From 5e1b61eb02272698023204a29c1d96e5350f4ceb Mon Sep 17 00:00:00 2001 From: redmatrix Date: Sun, 8 Nov 2015 20:02:35 -0800 Subject: some more db doco --- doc/database/db_conv.bb | 19 +++++++++++-------- doc/database/db_group_member.bb | 8 ++++---- doc/database/db_groups.bb | 12 ++++++------ doc/database/db_hook.bb | 10 +++++----- doc/database/db_item_id.bb | 10 +++++----- 5 files changed, 31 insertions(+), 28 deletions(-) (limited to 'doc') diff --git a/doc/database/db_conv.bb b/doc/database/db_conv.bb index ba1ba7f01..5adfa8c80 100644 --- a/doc/database/db_conv.bb +++ b/doc/database/db_conv.bb @@ -1,21 +1,24 @@ + +Used in Diaspora private mails + [table] [tr][th]Field[/th][th]Description[/th][th]Type[/th][th]Null[/th][th]Key[/th][th]Default[/th][th]Extra [/th][/tr] -[tr][td]id[/td][td][/td][td]int(10) unsigned[/td][td]NO[/td][td]PRI[/td][td]NULL[/td][td]auto_increment +[tr][td]id[/td][td]sequential ID[/td][td]int(10) unsigned[/td][td]NO[/td][td]PRI[/td][td]NULL[/td][td]auto_increment [/td][/tr] -[tr][td]guid[/td][td][/td][td]char(255)[/td][td]NO[/td][td][/td][td]NULL[/td][td] +[tr][td]guid[/td][td]A unique identifier for this conversation[/td][td]char(255)[/td][td]NO[/td][td][/td][td]NULL[/td][td] [/td][/tr] -[tr][td]recips[/td][td][/td][td]mediumtext[/td][td]NO[/td][td][/td][td]NULL[/td][td] +[tr][td]recips[/td][td]sender_handle;recipient_handle[/td][td]mediumtext[/td][td]NO[/td][td][/td][td]NULL[/td][td] [/td][/tr] -[tr][td]uid[/td][td][/td][td]int(11)[/td][td]NO[/td][td][/td][td]NULL[/td][td] +[tr][td]uid[/td][td]channel.channel_id of the owner of this data[/td][td]int(11)[/td][td]NO[/td][td][/td][td]NULL[/td][td] [/td][/tr] -[tr][td]creator[/td][td][/td][td]char(255)[/td][td]NO[/td][td][/td][td]NULL[/td][td] +[tr][td]creator[/td][td]handle of creator[/td][td]char(255)[/td][td]NO[/td][td][/td][td]NULL[/td][td] [/td][/tr] -[tr][td]created[/td][td][/td][td]datetime[/td][td]NO[/td][td]MUL[/td][td]0000-00-00 00:00:00[/td][td] +[tr][td]created[/td][td]creation timestamp[/td][td]datetime[/td][td]NO[/td][td]MUL[/td][td]0000-00-00 00:00:00[/td][td] [/td][/tr] -[tr][td]updated[/td][td][/td][td]datetime[/td][td]NO[/td][td]MUL[/td][td]0000-00-00 00:00:00[/td][td] +[tr][td]updated[/td][td]edited timestamp[/td][td]datetime[/td][td]NO[/td][td]MUL[/td][td]0000-00-00 00:00:00[/td][td] [/td][/tr] -[tr][td]subject[/td][td][/td][td]mediumtext[/td][td]NO[/td][td][/td][td]NULL[/td][td] +[tr][td]subject[/td][td]subject of initial message (obscured for privacy)[/td][td]mediumtext[/td][td]NO[/td][td][/td][td]NULL[/td][td] [/td][/tr] [/table] diff --git a/doc/database/db_group_member.bb b/doc/database/db_group_member.bb index d31fa1edb..b9ab8171d 100644 --- a/doc/database/db_group_member.bb +++ b/doc/database/db_group_member.bb @@ -1,13 +1,13 @@ [table] [tr][th]Field[/th][th]Description[/th][th]Type[/th][th]Null[/th][th]Key[/th][th]Default[/th][th]Extra [/th][/tr] -[tr][td]id[/td][td][/td][td]int(10) unsigned[/td][td]NO[/td][td]PRI[/td][td]NULL[/td][td]auto_increment +[tr][td]id[/td][td]sequential ID[/td][td]int(10) unsigned[/td][td]NO[/td][td]PRI[/td][td]NULL[/td][td]auto_increment [/td][/tr] -[tr][td]uid[/td][td][/td][td]int(10) unsigned[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]uid[/td][td]channel.channel_id of the owner of this data[/td][td]int(10) unsigned[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] -[tr][td]gid[/td][td][/td][td]int(10) unsigned[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]gid[/td][td]groups.id of the associated group[/td][td]int(10) unsigned[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] -[tr][td]xchan[/td][td][/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td][/td][td] +[tr][td]xchan[/td][td]xchan.xchan_hash of the member assigned to the associated group[/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td][/td][td] [/td][/tr] [/table] diff --git a/doc/database/db_groups.bb b/doc/database/db_groups.bb index 03e4fe2d7..078d96464 100644 --- a/doc/database/db_groups.bb +++ b/doc/database/db_groups.bb @@ -1,17 +1,17 @@ [table] [tr][th]Field[/th][th]Description[/th][th]Type[/th][th]Null[/th][th]Key[/th][th]Default[/th][th]Extra [/th][/tr] -[tr][td]id[/td][td][/td][td]int(10) unsigned[/td][td]NO[/td][td]PRI[/td][td]NULL[/td][td]auto_increment +[tr][td]id[/td][td]sequential ID[/td][td]int(10) unsigned[/td][td]NO[/td][td]PRI[/td][td]NULL[/td][td]auto_increment [/td][/tr] -[tr][td]hash[/td][td][/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td][/td][td] +[tr][td]hash[/td][td]unique hash representing this group with the group name appended[/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td][/td][td] [/td][/tr] -[tr][td]uid[/td][td][/td][td]int(10) unsigned[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]uid[/td][td]channel.channel_id owning this data[/td][td]int(10) unsigned[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] -[tr][td]visible[/td][td][/td][td]tinyint(1)[/td][td]NO[/td][td]MUL[/td][td]0[/td][td] +[tr][td]visible[/td][td]1 indicates the member list is not private[/td][td]tinyint(1)[/td][td]NO[/td][td]MUL[/td][td]0[/td][td] [/td][/tr] -[tr][td]deleted[/td][td][/td][td]tinyint(1)[/td][td]NO[/td][td]MUL[/td][td]0[/td][td] +[tr][td]deleted[/td][td]1 indicates the group has been deleted[/td][td]tinyint(1)[/td][td]NO[/td][td]MUL[/td][td]0[/td][td] [/td][/tr] -[tr][td]name[/td][td][/td][td]char(255)[/td][td]NO[/td][td][/td][td]NULL[/td][td] +[tr][td]name[/td][td]human readable name of group[/td][td]char(255)[/td][td]NO[/td][td][/td][td]NULL[/td][td] [/td][/tr] [/table] diff --git a/doc/database/db_hook.bb b/doc/database/db_hook.bb index 6e8e907a1..0812b1b41 100644 --- a/doc/database/db_hook.bb +++ b/doc/database/db_hook.bb @@ -1,15 +1,15 @@ [table] [tr][th]Field[/th][th]Description[/th][th]Type[/th][th]Null[/th][th]Key[/th][th]Default[/th][th]Extra [/th][/tr] -[tr][td]id[/td][td][/td][td]int(11)[/td][td]NO[/td][td]PRI[/td][td]NULL[/td][td]auto_increment +[tr][td]id[/td][td]sequential ID[/td][td]int(11)[/td][td]NO[/td][td]PRI[/td][td]NULL[/td][td]auto_increment [/td][/tr] -[tr][td]hook[/td][td][/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]hook[/td][td]name of hook[/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] -[tr][td]file[/td][td][/td][td]char(255)[/td][td]NO[/td][td][/td][td]NULL[/td][td] +[tr][td]file[/td][td]relative filename of hook handler[/td][td]char(255)[/td][td]NO[/td][td][/td][td]NULL[/td][td] [/td][/tr] -[tr][td]function[/td][td][/td][td]char(255)[/td][td]NO[/td][td][/td][td]NULL[/td][td] +[tr][td]function[/td][td]function name of hook handler[/td][td]char(255)[/td][td]NO[/td][td][/td][td]NULL[/td][td] [/td][/tr] -[tr][td]priority[/td][td][/td][td]int(11) unsigned[/td][td]NO[/td][td][/td][td]0[/td][td] +[tr][td]priority[/td][td]not yet implemented - can be used to sort conflicts in hook handling by calling handlers in priority order[/td][td]int(11) unsigned[/td][td]NO[/td][td][/td][td]0[/td][td] [/td][/tr] [/table] diff --git a/doc/database/db_item_id.bb b/doc/database/db_item_id.bb index b77ae2d1a..ba4cca247 100644 --- a/doc/database/db_item_id.bb +++ b/doc/database/db_item_id.bb @@ -1,15 +1,15 @@ [table] [tr][th]Field[/th][th]Description[/th][th]Type[/th][th]Null[/th][th]Key[/th][th]Default[/th][th]Extra [/th][/tr] -[tr][td]id[/td][td][/td][td]int(10) unsigned[/td][td]NO[/td][td]PRI[/td][td]NULL[/td][td]auto_increment +[tr][td]id[/td][td]sequential ID[/td][td]int(10) unsigned[/td][td]NO[/td][td]PRI[/td][td]NULL[/td][td]auto_increment [/td][/tr] -[tr][td]iid[/td][td][/td][td]int(11)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]iid[/td][td]item.id of the referenced item[/td][td]int(11)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] -[tr][td]uid[/td][td][/td][td]int(11)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]uid[/td][td]channel.channel_id of the owner of this data[/td][td]int(11)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] -[tr][td]sid[/td][td][/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]sid[/td][td]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)[/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] -[tr][td]service[/td][td][/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]service[/td][td]the name or description of the service which generated this identifier[/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] [/table] -- cgit v1.2.3 From 99bd69adfe3ad578d6937cfc03e333d4913881c6 Mon Sep 17 00:00:00 2001 From: redmatrix Date: Mon, 9 Nov 2015 00:59:48 -0800 Subject: remove references to redmatrix.me --- doc/bbcode.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'doc') diff --git a/doc/bbcode.html b/doc/bbcode.html index 4fe47842f..3e9bda1d9 100644 --- a/doc/bbcode.html +++ b/doc/bbcode.html @@ -7,11 +7,11 @@
  • [u]underlined[/u] - underlined
  • [s]strike[/s] - strike
  • [color=red]red[/color] - red
    -
  • [url=https://redmatrix.me]$Projectname[/url] $Projectname
    -
  • [img]https://redmatrix.me/images/default_profile_photos/rainbow_man/48.jpg[/img] Image/photo
    -
  • [img float=left]https://redmatrix.me/images/default_profile_photos/rainbow_man/48.jpg[/img] Image/photo
    +
  • [url=https://zothub.com]$Projectname[/url] $Projectname
    +
  • [img]https://zothub.com/images/default_profile_photos/rainbow_man/48.jpg[/img] Image/photo
    +
  • [img float=left]https://zothub.com/images/default_profile_photos/rainbow_man/48.jpg[/img] Image/photo
    -
  • [img float=right]https://redmatrix.me/images/default_profile_photos/rainbow_man/48.jpg[/img] Image/photo
    +
  • [img float=right]https://zothub.com/images/default_profile_photos/rainbow_man/48.jpg[/img] Image/photo
  • [code]code[/code] code
  • [quote]quote[/quote]
    quote

    @@ -50,8 +50,8 @@

    $Projectname specific codes

    • [©] © This works for many HTML entities
      • -
    • [zrl]https://redmatrix.me[/zrl] Magic-auth version of [url] tag
      • -
    • [zmg]https://redmatrix.me/some/photo.jpg[/zmg] Magic-auth version of [img] tag
      • +
    • [zrl]https://zothub.com[/zrl] Magic-auth version of [url] tag
      • +
    • [zmg]https://zothub.com/some/photo.jpg[/zmg] Magic-auth version of [img] tag
    • [observer=1]Text to display if observer is authenticated in the matrix[/observer]
    • [observer=0]Text to display if observer is not authenticated in the matrix[/observer]
      • -- cgit v1.2.3 From c0260ff7018c1f29cf27d6fdb6ff6c7e4db5fff4 Mon Sep 17 00:00:00 2001 From: redmatrix Date: Mon, 9 Nov 2015 18:25:18 -0800 Subject: more doco --- doc/hook/app_menu.bb | 1 - doc/hook/cron.bb | 4 ++++ doc/hook/cron_daily.bb | 2 ++ doc/hook/cron_weekly.bb | 2 ++ doc/hook/smilie.bb | 18 ++++++++++++++++++ doc/hook/tagged.bb | 15 +++++++++++++++ doc/hooklist.bb | 3 --- 7 files changed, 41 insertions(+), 4 deletions(-) delete mode 100644 doc/hook/app_menu.bb (limited to 'doc') diff --git a/doc/hook/app_menu.bb b/doc/hook/app_menu.bb deleted file mode 100644 index 0458a692a..000000000 --- a/doc/hook/app_menu.bb +++ /dev/null @@ -1 +0,0 @@ -[h2]app_menu[/h2] diff --git a/doc/hook/cron.bb b/doc/hook/cron.bb index ebbb64d50..55120b6c2 100644 --- a/doc/hook/cron.bb +++ b/doc/hook/cron.bb @@ -1 +1,5 @@ [h2]cron[/h2] + +Called when cron task (include/poller.php) is executed. The hook data is a string representing the current time (UTC). + + diff --git a/doc/hook/cron_daily.bb b/doc/hook/cron_daily.bb index c5062330a..802bea5e4 100644 --- a/doc/hook/cron_daily.bb +++ b/doc/hook/cron_daily.bb @@ -1 +1,3 @@ [h2]cron_daily[/h2] + +Called when cron task (include/poller.php) performs a cron_daily operation. The hook data is a string representing the current time (UTC). diff --git a/doc/hook/cron_weekly.bb b/doc/hook/cron_weekly.bb index 8dc85e494..c01bf9611 100644 --- a/doc/hook/cron_weekly.bb +++ b/doc/hook/cron_weekly.bb @@ -1 +1,3 @@ [h2]cron_weekly[/h2] + +Called when cron task (include/poller.php) performs a cron_weekly operation. The hook data is a string representing the current time (UTC). diff --git a/doc/hook/smilie.bb b/doc/hook/smilie.bb index cea3e0c94..575acc178 100644 --- a/doc/hook/smilie.bb +++ b/doc/hook/smilie.bb @@ -1 +1,19 @@ [h2]smilie[/h2] + + +Called when processing translation of emoticons. It is passed an array containing two sub-arrays: + + array( + 'texts' => array('text1','text2',...), + 'icons' => array('icon1','icon2',...) + ); + + texts is the emoticon text - for example ':-)' for a traditional smile face. + icons is the HTML used as a replacement. For example + '<img class="smiley" src="https://localhost/images/smiley-smile.gif" alt=":-)" />' + + If adding or removing an entry from either array, the corresponding element from the matching array must also + be added or removed. Emoticons less than three characters in length or not recommended as they get triggered + incorrectly quite often. Extended emoticons are indicated by convention using a preceding colon, for example + + :walrus_kissing_a_baby \ No newline at end of file diff --git a/doc/hook/tagged.bb b/doc/hook/tagged.bb index 5add76713..05d081d07 100644 --- a/doc/hook/tagged.bb +++ b/doc/hook/tagged.bb @@ -1 +1,16 @@ [h2]tagged[/h2] + + +This hook is called when a delivery is made which results in the recipient being tagged. + +The hook data is an array containing + + array( + 'channel_id' => int, + 'item' => item structure of the delivered item from database, + 'body' => the body of the referenced item + + ); + + Note: This hook is called before secondary delivery chains are invoked in the case of tagging a forum. This means that permissions and some item attributes will be those of the item before being re-packaged and before ownership of this item is given to the forum. + diff --git a/doc/hooklist.bb b/doc/hooklist.bb index 171885851..666a34ca2 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -40,9 +40,6 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/api_perm_is_allowed]api_perm_is_allowed[/zrl] Called when perm_is_allowed() is executed from an API call. -[zrl=[baseurl]/help/hook/app_menu]app_menu[/zrl] - Used to register plugins as apps - [zrl=[baseurl]/help/hook/atom_author]atom_author[/zrl] Called when generating an author or owner element for an Atom ActivityStream feed -- cgit v1.2.3 From e6de9bfa4ebe1fb1c7dd05c0d572c7d79d3323ee Mon Sep 17 00:00:00 2001 From: redmatrix Date: Mon, 9 Nov 2015 19:42:37 -0800 Subject: get rid of the pre-comanche widget placement and wgl code --- doc/hook/get_widgets.bb | 1 - doc/hooklist.bb | 3 --- 2 files changed, 4 deletions(-) delete mode 100644 doc/hook/get_widgets.bb (limited to 'doc') diff --git a/doc/hook/get_widgets.bb b/doc/hook/get_widgets.bb deleted file mode 100644 index 54b43858a..000000000 --- a/doc/hook/get_widgets.bb +++ /dev/null @@ -1 +0,0 @@ -[h2]get_widgets[/h2] diff --git a/doc/hooklist.bb b/doc/hooklist.bb index 666a34ca2..0b9cc17ee 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -209,9 +209,6 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/get_role_perms]get_role_perms[/zrl] Called when get_role_perms() is called to obtain permissions for named permission roles -[zrl=[baseurl]/help/hook/get_widgets]get_widgets[/zrl] - No longer used - now widget placement is managed by Comanche - [zrl=[baseurl]/help/hook/global_permissions]global_permissions[/zrl] Called when the global permissions list is generated -- cgit v1.2.3 From c4a3487f0cee6391419fd73f2f89f074731a064c Mon Sep 17 00:00:00 2001 From: redmatrix Date: Mon, 9 Nov 2015 20:29:36 -0800 Subject: remove the obsolete avatar_img function (gravatar/libravatar lookup) --- doc/hook/avatar_lookup.bb | 1 - doc/hooklist.bb | 3 --- 2 files changed, 4 deletions(-) delete mode 100644 doc/hook/avatar_lookup.bb (limited to 'doc') diff --git a/doc/hook/avatar_lookup.bb b/doc/hook/avatar_lookup.bb deleted file mode 100644 index abd84de5e..000000000 --- a/doc/hook/avatar_lookup.bb +++ /dev/null @@ -1 +0,0 @@ -[h2]avatar_lookup[/h2] diff --git a/doc/hooklist.bb b/doc/hooklist.bb index 0b9cc17ee..2285ef1cf 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -58,9 +58,6 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/authenticate]authenticate[/zrl] Can provide alternate authentication mechanisms -[zrl=[baseurl]/help/hook/avatar_lookup]avatar_lookup[/zrl] - Used for "gravatar" or libravatar profile photo lookup. - [zrl=[baseurl]/help/hook/bb2diaspora]bb2diaspora[/zrl] called when converting bbcode to markdown -- cgit v1.2.3 From 7ec687988746e1037d86d25186c2dd5f2addb15b Mon Sep 17 00:00:00 2001 From: redmatrix Date: Mon, 9 Nov 2015 20:56:37 -0800 Subject: more doco --- doc/hook/probe_well_known.bb | 2 ++ doc/hook/validate_channelname.bb | 22 ++++++++++++++++++++++ 2 files changed, 24 insertions(+) (limited to 'doc') diff --git a/doc/hook/probe_well_known.bb b/doc/hook/probe_well_known.bb index eff690f31..62898c536 100644 --- a/doc/hook/probe_well_known.bb +++ b/doc/hook/probe_well_known.bb @@ -1 +1,3 @@ [h2]probe_well_known[/h2] + +This hook is under construction and not currently used - see include/probe.php \ No newline at end of file diff --git a/doc/hook/validate_channelname.bb b/doc/hook/validate_channelname.bb index c78961017..2ab12bbec 100644 --- a/doc/hook/validate_channelname.bb +++ b/doc/hook/validate_channelname.bb @@ -1 +1,23 @@ [h2]validate_channelname[/h2] + +Called when creating a new channel or changing the channel name in mod/settings.php + +Hook data consists of an array + + array( + 'name' => supplied name + ); + + If the hook handler determines the name is valid, do nothing. If there is an issue with the name, + set $hook_data['message'] to the message text which should be displayed to the member - and the name will + not be accepted. + + + Example: + [code] + if(mb_strlen($hook_data['name']) < 3) + $hook_data['message'] = t('Name too short.'); + [/code] + + + \ No newline at end of file -- cgit v1.2.3