From 064962ff82701d9d415a351a91354a0cdf949bd5 Mon Sep 17 00:00:00 2001 From: friendica Date: Fri, 14 Feb 2014 12:25:27 -0800 Subject: doc and assets update. There is what seems to be a controversial powerpoint in this checkin. The powerpoint is of course *open source* even if powerpoint itself is not. The source file is available for your examination and revision. --- doc/html/zot_8php.html | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) (limited to 'doc/html/zot_8php.html') diff --git a/doc/html/zot_8php.html b/doc/html/zot_8php.html index e1b1e559b..129745ae5 100644 --- a/doc/html/zot_8php.html +++ b/doc/html/zot_8php.html @@ -122,8 +122,8 @@ Functions    zot_finger ($webbie, $channel, $autofallback=true)   - zot_refresh ($them, $channel=null) -  + zot_refresh ($them, $channel=null, $force=false) +   zot_gethub ($arr)    zot_register_hub ($arr) @@ -357,7 +357,7 @@ Functions
-

Referenced by import_xchan(), process_profile_delivery(), and syncdirs().

+

Referenced by import_xchan(), local_dir_update(), and process_profile_delivery().

@@ -412,17 +412,17 @@ Functions
-

import_xchan($arr,$ud_flags = 1) Takes an associative array of a fecthed discovery packet and updates all internal data structures which need to be updated as a result.

+

import_xchan($arr,$ud_flags = 1) Takes an associative array of a fetched discovery packet and updates all internal data structures which need to be updated as a result.

Parameters
- +
array$arr=> json_decoded discovery packet
int$ud_flagsDetermines whether to create a directory update record if any changes occur, default 1 or true
int$ud_flagsDetermines whether to create a directory update record if any changes occur, default 1 or true $ud_flags = (-1) indicates a forced refresh where we unconditionally create a directory update record this typically occurs once a month for each channel as part of a scheduled ping to notify the directory that the channel still exists
Returns
array => 'success' (boolean true or false) 'message' (optional error string only if success is false)
-

Referenced by chanview_content(), gprobe_run(), magic_init(), mail_post(), new_contact(), poco_load(), post_init(), update_directory_entry(), zot_refresh(), and zot_register_hub().

+

Referenced by chanview_content(), gprobe_run(), magic_init(), mail_post(), new_contact(), poco_load(), post_init(), process_channel_sync_delivery(), update_directory_entry(), zot_refresh(), and zot_register_hub().

@@ -690,7 +690,7 @@ Functions
-

Referenced by import_directory_profile(), import_xchan(), and syncdirs().

+

Referenced by import_directory_profile(), import_xchan(), and local_dir_update().

@@ -739,10 +739,10 @@ Functions
Parameters
- + - +
array$channel=> sender channel structure
string$type=> packet type: one of 'ping', 'pickup', 'purge', 'refresh', 'notify', 'auth_check'
string$type=> packet type: one of 'ping', 'pickup', 'purge', 'refresh', 'force_refresh', 'notify', 'auth_check'
array$recipients=> envelope information, array ( 'guid' => string, 'guid_sig' => string ); empty for public posts
string$remote_key=> optional public site key of target hub used to encrypt entire packet NOTE: remote_key and encrypted packets are required for 'auth_check' packets, optional for all others
string$secret=> random string, required for packets which require verification/callback e.g. 'pickup', 'purge', 'notify', 'auth_check' — 'ping' and 'refresh' do not require verification
string$secret=> random string, required for packets which require verification/callback e.g. 'pickup', 'purge', 'notify', 'auth_check'. Packet types 'ping', 'force_refresh', and 'refresh' do not require verification
@@ -823,7 +823,7 @@ which will be processed and delivered before this function ultimately returns.
Returns
: array => see z_post_url and mod/zfinger.php
-

Referenced by chanview_content(), gprobe_run(), magic_init(), mail_post(), new_contact(), poco_load(), post_init(), probe_content(), and update_directory_entry().

+

Referenced by chanview_content(), gprobe_run(), magic_init(), mail_post(), new_contact(), poco_load(), post_init(), probe_content(), process_channel_sync_delivery(), and update_directory_entry().

@@ -849,7 +849,7 @@ which will be processed and delivered before this function ultimately returns.

Only search for active hublocs - e.g. those that haven't been marked deleted

-

Referenced by zfinger_init().

+

Referenced by process_channel_sync_delivery(), and zfinger_init().

@@ -992,7 +992,7 @@ which will be processed and delivered before this function ultimately returns. - +
@@ -1006,7 +1006,13 @@ which will be processed and delivered before this function ultimately returns. - + + + + + + + @@ -1015,7 +1021,7 @@ which will be processed and delivered before this function ultimately returns.
 $channel = null $channel = null,
 $force = false 
-

: zot_refresh($them, $channel = null)

+

: zot_refresh($them, $channel = null, $force = false)

zot_refresh is typically invoked when somebody has changed permissions of a channel and they are notified to fetch new permissions via a finger/discovery operation. This may result in a new connection (abook entry) being added to a local channel and it may result in auto-permissions being granted.

Friending in zot is accomplished by sending a refresh packet to a specific channel which indicates a permission change has been made by the sender which affects the target channel. The hub controlling the target channel does targetted discovery (a zot-finger request requesting permissions for the local channel). These are decoded here, and if necessary and abook structure (addressbook) is created to store the permissions assigned to this channel.

Initially these abook structures are created with a 'pending' flag, so that no reverse permissions are implied until this is approved by the owner channel. A channel can also auto-populate permissions in return and send back a refresh packet of its own. This is used by forum and group communication channels so that friending and membership in the channel's "club" is automatic.

-- cgit v1.2.3