diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/context/admin/security/help.html | 3 | ||||
| -rw-r--r-- | doc/context/channel/help.html | 24 | ||||
| -rw-r--r-- | doc/context/cloud/help.html | 22 | ||||
| -rw-r--r-- | doc/context/mail/help.html | 10 | ||||
| -rw-r--r-- | doc/context/network/help.html | 26 | ||||
| -rw-r--r-- | doc/context/photos/help.html | 22 | ||||
| -rw-r--r-- | doc/context/profile/help.html | 22 | ||||
| -rw-r--r-- | doc/federate.bb | 7 | ||||
| -rw-r--r-- | doc/filesync.md | 61 |
9 files changed, 195 insertions, 2 deletions
diff --git a/doc/context/admin/security/help.html b/doc/context/admin/security/help.html new file mode 100644 index 000000000..e9a741a5e --- /dev/null +++ b/doc/context/admin/security/help.html @@ -0,0 +1,3 @@ +<h3>Security Settings</h3> +<p>This page contains various administrator settings related to security.</p> +<p>To save any changes you make to these settings, you must press the Submit button.</p>
\ No newline at end of file diff --git a/doc/context/channel/help.html b/doc/context/channel/help.html new file mode 100644 index 000000000..810913ff3 --- /dev/null +++ b/doc/context/channel/help.html @@ -0,0 +1,24 @@ +<script> + var contextualHelp1 = function (target, openSidePanel) { + $("#help-content").removeClass('help-content-open'); // Close the help panel + $("#navbar-collapse-1").removeClass('in'); // Collapse the navbar for small screens + if (openSidePanel) { + $("main").addClass('region_1-on'); // Open the side panel to highlight element + } else { + $("main").removeClass('region_1-on'); + } + // Animate the page scroll to the element and then pulse the element to direct attention + $('html,body').animate({scrollTop: $(target).offset().top - $('#navbar-collapse-1').height() - 20}, 'slow'); + for (i = 0; i < 3; i++) { + $(target).fadeTo('slow', 0.1).fadeTo('slow', 1.0); + } + } +</script> +<dl class="dl-horizontal"> + <dt>General</dt> + <dd>This is the home page of a channel. It is similar to someone's profile "wall" in a social network context. Posts created by the channel are displayed according to the observer's viewing permissions.</dd> + <dt>Create a Post</dt> + <dd>If you have permission to create posts on the channel page, then you will see the post editor at the top.</dd> + <dt><a href='#' onclick='contextualHelp1("#tabs-collapse-1", 0); return false;' title="Click to highlight element...">Channel Content Tabs</a></dt> + <dd>The channel content tabs are links to other content published by the channel. The <b>About</b> tab links to the channel profile. The <b>Photos</b> tab links to the channel photo galleries. The <b>Files</b> tab links to the general shared files published by the channel.</dd> +</dl>
\ No newline at end of file diff --git a/doc/context/cloud/help.html b/doc/context/cloud/help.html new file mode 100644 index 000000000..105947517 --- /dev/null +++ b/doc/context/cloud/help.html @@ -0,0 +1,22 @@ +<script> + var contextualHelp1 = function (target, openSidePanel) { + $("#help-content").removeClass('help-content-open'); // Close the help panel + $("#navbar-collapse-1").removeClass('in'); // Collapse the navbar for small screens + if (openSidePanel) { + $("main").addClass('region_1-on'); // Open the side panel to highlight element + } else { + $("main").removeClass('region_1-on'); + } + // Animate the page scroll to the element and then pulse the element to direct attention + $('html,body').animate({scrollTop: $(target).offset().top - $('#navbar-collapse-1').height() - 20}, 'slow'); + for (i = 0; i < 3; i++) { + $(target).fadeTo('slow', 0.1).fadeTo('slow', 1.0); + } + } +</script> +<dl class="dl-horizontal"> + <dt>General</dt> + <dd>This page displays a channel's "cloud" files. The files visible to the observer depend on the individual file permissions set by the channel owner. If you have permission to create/upload files you will see control buttons above the file list.</dd> + <dt><a href='#' onclick='contextualHelp1("#tabs-collapse-1", 0); return false;' title="Click to highlight element...">Channel Content Tabs</a></dt> + <dd>The channel content tabs are links to other content published by the channel. The <b>About</b> tab links to the channel profile. The <b>Photos</b> tab links to the channel photo galleries. The <b>Files</b> tab links to the general shared files published by the channel.</dd> +</dl>
\ No newline at end of file diff --git a/doc/context/mail/help.html b/doc/context/mail/help.html new file mode 100644 index 000000000..a2361a135 --- /dev/null +++ b/doc/context/mail/help.html @@ -0,0 +1,10 @@ +<dl class="dl-horizontal"> + <dt>General</dt> + <dd>The messages displayed in private mail are visible only to you and the single recipient. </dd> + <dt>Combined View</dt> + <dd>Complete conversations can be viewed in a continuous thread by selecting <b>Combined View</b>. Available conversations are displayed beneath the menu in the side panel.</dd> + <dt>Inbox/Outbox</dt> + <dd>Individual sent messages are viewed by selecting <b>Outbox</b>, and incoming messages are viewed using the <b>Inbox</b> filter.</dd> + <dt>New Message</dt> + <dd>Individual messages have delivery reports that can be viewed using the drop-down menu. Messages can also be recalled from the same menu, which can prevent the recipient from viewing the message <i>if they have not already read it</i>.</dd> +</dl>
\ No newline at end of file diff --git a/doc/context/network/help.html b/doc/context/network/help.html new file mode 100644 index 000000000..956af7380 --- /dev/null +++ b/doc/context/network/help.html @@ -0,0 +1,26 @@ +<script> + var contextualHelp1 = function (target, openSidePanel) { + $("#help-content").removeClass('help-content-open'); // Close the help panel + $("#navbar-collapse-1").removeClass('in'); // Collapse the navbar for small screens + if (openSidePanel) { + $("main").addClass('region_1-on'); // Open the side panel to highlight element + } else { + $("main").removeClass('region_1-on'); + } + // Animate the page scroll to the element and then pulse the element to direct attention + $('html,body').animate({scrollTop: $(target).offset().top - $('#navbar-collapse-1').height() - 20}, 'slow'); + for (i = 0; i < 3; i++) { + $(target).fadeTo('slow', 0.1).fadeTo('slow', 1.0); + } + } +</script> +<dl class="dl-horizontal"> + <dt>General</dt> + <dd>The network page displays a stream of posts and conversations, typically ordered by the most recently updated. This page is highly customizable.</dd> + <dt><a href='#' onclick='contextualHelp1("#profile-jot-wrapper", 0); return false;' title="Click to highlight element...">Create a Post</a></dt> + <dd>At the top of the page there is a text box that says "Share". Clicking this box opens a new post editor. The post editor is customizable, but the basic editor provides fields for a post body and an optional post <b>Title</b>. Buttons below the text area to the left provide shortcuts to text formatting and inserting links, images, and other data into the post. The buttons to the right provide a post preview, the post permissions setting, and a <b>Submit</b> button to send the post.</dd> + <dt><a href='#' onclick='contextualHelp1("#group-sidebar", 1); return false;' title="Click to highlight element...">Privacy Groups</a></dt> + <dd>The privacy groups you have created are displayed in the side panel. Selecting them filters posts to those created by channels in the chosen group.</dd> + <dt><a href='#' onclick='$("#dbtn-acl").click(); return false;' title="Click to highlight element...">Post Permissions</a></dt> + <dd>The access control list (ACL) is what you use to set who can see your new post. Pressing the ACL button beside the Submit button will display a dialog in which you can select what channels and/or privacy groups can see the post. You can also select who is explicitly denied access. For example, say you are planning a surprise party for a friend. You can send an invitation post to everyone in your <b>Friends</b> group <i>except</i> the friend you are surprising. In this case you "show" the <b>Friends</b> group but "don't show" that one person.</dd> +</dl>
\ No newline at end of file diff --git a/doc/context/photos/help.html b/doc/context/photos/help.html new file mode 100644 index 000000000..f41611f8d --- /dev/null +++ b/doc/context/photos/help.html @@ -0,0 +1,22 @@ +<script> + var contextualHelp1 = function (target, openSidePanel) { + $("#help-content").removeClass('help-content-open'); // Close the help panel + $("#navbar-collapse-1").removeClass('in'); // Collapse the navbar for small screens + if (openSidePanel) { + $("main").addClass('region_1-on'); // Open the side panel to highlight element + } else { + $("main").removeClass('region_1-on'); + } + // Animate the page scroll to the element and then pulse the element to direct attention + $('html,body').animate({scrollTop: $(target).offset().top - $('#navbar-collapse-1').height() - 20}, 'slow'); + for (i = 0; i < 3; i++) { + $(target).fadeTo('slow', 0.1).fadeTo('slow', 1.0); + } + } +</script> +<dl class="dl-horizontal"> + <dt>General</dt> + <dd>This page displays a channel's photo albums. The images visible to the observer depend on the individual image permissions.</dd> + <dt><a href='#' onclick='contextualHelp1("#tabs-collapse-1", 0); return false;' title="Click to highlight element...">Channel Content Tabs</a></dt> + <dd>The channel content tabs are links to other content published by the channel. The <b>About</b> tab links to the channel profile. The <b>Photos</b> tab links to the channel photo galleries. The <b>Files</b> tab links to the general shared files published by the channel.</dd> +</dl>
\ No newline at end of file diff --git a/doc/context/profile/help.html b/doc/context/profile/help.html new file mode 100644 index 000000000..0d4abb8cb --- /dev/null +++ b/doc/context/profile/help.html @@ -0,0 +1,22 @@ +<script> + var contextualHelp1 = function (target, openSidePanel) { + $("#help-content").removeClass('help-content-open'); // Close the help panel + $("#navbar-collapse-1").removeClass('in'); // Collapse the navbar for small screens + if (openSidePanel) { + $("main").addClass('region_1-on'); // Open the side panel to highlight element + } else { + $("main").removeClass('region_1-on'); + } + // Animate the page scroll to the element and then pulse the element to direct attention + $('html,body').animate({scrollTop: $(target).offset().top - $('#navbar-collapse-1').height() - 20}, 'slow'); + for (i = 0; i < 3; i++) { + $(target).fadeTo('slow', 0.1).fadeTo('slow', 1.0); + } + } +</script> +<dl class="dl-horizontal"> + <dt>General</dt> + <dd>This is the profile page of a channel. It typically displays information describing the channel. If the channel represents a person in a social network, for example, then the profile might provide contact information and other personal details about the person. Channels can have multiple profiles, where the displayed profile depends on the observer.</dd> + <dt><a href='#' onclick='contextualHelp1("#tabs-collapse-1", 0); return false;' title="Click to highlight element...">Channel Content Tabs</a></dt> + <dd>The channel content tabs are links to other content published by the channel. The <b>About</b> tab links to the channel profile. The <b>Photos</b> tab links to the channel photo galleries. The <b>Files</b> tab links to the general shared files published by the channel.</dd> +</dl>
\ No newline at end of file diff --git a/doc/federate.bb b/doc/federate.bb index 5d253913d..9137ec160 100644 --- a/doc/federate.bb +++ b/doc/federate.bb @@ -8,7 +8,7 @@ There are three main components to writing federation plugins. These are: In addition, federation drivers must handle -[4] differences in privacy policies +[4] differences in privacy policies (and content formats) [h3]Making connections[/h3] @@ -36,8 +36,11 @@ Additional information that your plugin requires for communication can be stored When a connection is made, we generally call the notifier (include/notifier.php) to send a message to the remote channel. This is bound to the hook 'permissions_create'. Your plugin will need to handle this in order to send a "follow" or "make friends" message to the other network. -Note: The first stage zot lookup will be replaced with a webfinger lookup. This work is in progress. A separate lookup was required initially as webfinger does not allow non-SSL connections. We will provide non-SSL zot lookups (usually test and development sites) via the "old" XRD based webfinger to avoid this limitation. +Notes: The first stage zot lookup will be replaced with a webfinger lookup. This work is in progress. A separate lookup was required initially as webfinger does not allow non-SSL connections. We will provide non-SSL zot lookups (usually test and development sites) via the "old" XRD based webfinger to avoid this limitation. +The core application will attempt to create xchan records for projects identified as members of the "open web"; currently Hubzilla, Friendica, Diaspora, GNU-Social and Pump.io. This is so that comments can be passed amongst project sites and the network correctly identified. A federation plugin is required to fully federate with other networks, but comments may be passed to sites without such a plugin installed so that there are no unexplained holes in conversations. + +The core application must also provide signing ability for Diaspora comments since they require a special signing format and must be signed by the comment author regardless of whether that channel federates with Diaspora. The owner of the conversation may federate with Diaspora so the comments must be signed. This is unfortunate but necessary. [h3]Sending Messages[/h3] diff --git a/doc/filesync.md b/doc/filesync.md new file mode 100644 index 000000000..4c64bdb09 --- /dev/null +++ b/doc/filesync.md @@ -0,0 +1,61 @@ +File Sync and Clone +=================== + + + +File cloning across multiple instances of a channel is a very hard problem, due to the nature of PHP memory allocation. This needs to be handled dramatically differently than cloning or syncing of other information. (Processing one large video file or 40-50 photos could exhaust memory). Therefore we can't easily just dump all the data to a dump file and sequentially process it. Loading the dump file itself is likely to exhaust memory. + +There are also two primary operations we are considering. The first is the hardest - saving and then importing all your channel information into a new channel clone. The second is synchronising file changes as they occur across two or more "active" clones. + +For the first cut at this tool we will concentrate on the second case, while trying to maintain some measure of compatibility with the first case so that we can re-use the same tools. + +Meta Data +========= + + +First we need the metadata for the file in order to precisely re-construct its structure on another site. This requires the following information: + +'attach' structure (without file contents - which is the default) for the file itself **and** its parent directories so that we can re-create its precise place in the file system, since we do not know if the parent directory has been imported previously or ever. + +'photo' structure for any photo elements which were created as a result of uploading this file into the system. This typically contains several different 'scales' or thumbnail images, some of which may be cropped for profile photo use or cover photo use. We need to retain the cropping information which is not present in the metadata, but only in the stored data. The actual thumbnail image data may or may not be included in the metadata. A cover photo of large scale (scale #7) could potentially cause memory issues. Not as bad as a 100M video, but if you have several of these they could add up. + +'item' entries which are linked to this file. These can be file share activities, the "parent item" linked to photos, and any attached conversation items (photo likes, comments, etc.) + +All of these items will require URL replacement and re-signing of the item as they are relocated to another site. + + +File Data +========= + +Then we have the actual file data we need to reconstruct the file. This needs to be stored separately from the meta-data to avoid memory exhaustion when processing. The actual file data can be used to reconstruct the attach structure and the first four photo scales. If this is a photo, we need access to the "#4 scale" (profile photo) and the #7 scale (cover photo) as they were originally cropped. All other thumbnails can be generated from these. + + + +File Sync +========= + + +We will consider this operation first because it is probably the most straightforward to implement. When a photo is added to or removed or changed from the source system, we will send a clone sync packet to all known clones containing the metadata - but **no file data** . We can only send one sync packet per file operation that needs to be synced. + +The receiving end will create and perform URL translation on all the metadata structures and store them. Then it will need to fetch the actual data. Assuming CURL supports streaming, an authenticated request is sent to the original site and the original file is requested and streamed directly to disk (bypassing all processing). If photo scale #4 or scale #7 is required, these are requested and stored into their respective structures. We're assuming in this case that the cover photo large scale will not exhaust memory. If CURL cannot be made to support streaming, request packets need to be queued and sent to the origination site to obtain "chunks" of the file and re-assembled once all chunks have been retrieved. + +The authenticated request depends on the mechanism. For CURL streaming, some signed secret with a timestamp will probably need to be generated and posted to the file origination site. Then the data can be retrieved with minimal internal processing and dumped directly to disk using stdio buffering. In the case of a zot request, the zot request packet will be validated, however scheduling chunk batches and re-assembling them could be tricky. + + +File Backup/Restore +=================== + +This is much more complicated as we do not have an authenticate web server to request data from. The metadata can be mostly the same, but we need some form of signalling that we will not be fetching the file via the web. This will likely require a client side process to parse each metadata file and locate a file on disk which it is associated with. Then the data would need to be streamed to the destination server with a special endpoint designed for this task. A java app might be the best option here to retain platform neutrality. + +Another option would be to use WebDAV for this step. The metadata files would be uploaded first, and then the data files. If a data file corresponded to an existing metadata file, the metadata would be processed; the file stored appropriately, and the metadata file then removed. In this case, photos of scales 4 and 7 would need to be provided in the metadata. + + +Optionally, this step could also be performed with a filesystem local to the destination server. This would be the highest performance, and a suite of shell-based tools (in the case of Linux) could perform the "client-side" of the task. + +The complexity of this task mandates careful planning into how the data is organised and stored and if necessary backed up remotely or transmitted for backup by the source website. + + +Backward Compatibility +====================== + +There are some obvious issues with making data available for backup or cloning which existed on the system prior to the existence of restore/sync tools. To keep the tools themselves relatively uncomplicated (to the extent possible given the constraints) backward compatibility may have to be preformed by dedicated plugin or addon.
\ No newline at end of file |