Sometimes called Access Control List, or ACL, the permissions set who is able to see your new post.
+
The permissions dialog lets you select which 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 Friends group except the friend you are surprising. In this case you "Show" the Friends group but "Don't show" that one person.
-
Pressing the ACL button ( or ) 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 Friends group except the friend you are surprising. In this case you "Show" the Friends group but "Don't show" that one person.
-
-
-
Tip:
-
The border color of each channel indicates whether that channel — or one of the groups it belongs to — has access to the post. The border color will also indicate when a channel [or group it belongs to] has been expliciyly set to "Don't show".
+
+
Tip!
+
The border color of each channel indicates whether that channel — or one of the groups it's a member of — will have access to the post. The border color will also indicate when a channel, or group it belongs to, has been explicitly set to "Don't show".
Why can't I edit a post's permissions after I saved it?
diff --git a/doc/dev-function-overview.md b/doc/dev-function-overview.md
index 1ef80d343..fa8a98ff3 100644
--- a/doc/dev-function-overview.md
+++ b/doc/dev-function-overview.md
@@ -1,5 +1,5 @@
-Red development - some useful basic functions
-=============================================
+$Projectname development - some useful basic functions
+======================================================
@@ -17,11 +17,11 @@ Returns authenticated string hash of Red global identifier, if authenticated via
* get_app()
-Returns the global app structure ($a).
+Returns the global app structure ($a). No longer used as App is a static class
* App::get_observer()
-(App:: is usually assigned to the global $a), so App::get_observer() or App::get_observer() - returns an xchan structure representing the current viewer if authenticated (locally or remotely).
+returns an xchan structure representing the current viewer if authenticated (locally or remotely).
* get_config($family,$key), get_pconfig($uid,$family,$key)
diff --git a/doc/developer_function_primer.bb b/doc/developer_function_primer.bb
index 373454440..684fea569 100644
--- a/doc/developer_function_primer.bb
+++ b/doc/developer_function_primer.bb
@@ -1,4 +1,4 @@
-[b]Red development - some useful basic functions[/b]
+[b]$Projectname development - some useful basic functions[/b]
[b]get_account_id()[/b]
@@ -18,7 +18,7 @@ Returns the global app structure ($a).
[b]App::get_observer()[/b]
-(App:: is usually assigned to the global $a), so $a->get_observer() or get_app()->get_observer() - returns an xchan structure representing the current viewer if authenticated (locally or remotely).
+returns an xchan structure representing the current viewer if authenticated (locally or remotely).
[b]get_config($family,$key), get_pconfig($uid,$family,$key), get_xconfig($xchan_hash,$family,$key)[/b]
diff --git a/doc/hooklist.bb b/doc/hooklist.bb
index 9331873b4..bb1bffcf0 100644
--- a/doc/hooklist.bb
+++ b/doc/hooklist.bb
@@ -70,6 +70,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the
[zrl=[baseurl]/help/hook/bbcode]bbcode[/zrl]
Called when converting bbcode to HTML
+[zrl=[baseurl]/help/hook/bb_translate_video]bb_translate_video[/zrl]
+ Called when extracting embedded services from bbcode video elements (rarely used)
+
[zrl=[baseurl]/help/hook/channel_remove]channel_remove[/zrl]
Called when removing a channel
@@ -242,8 +245,11 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the
[zrl=[baseurl]/help/hook/hostxrd]hostxrd[/zrl]
Called when generating .well-known/hosts-meta for "old webfinger" (used by Diaspora protocol)
+[zrl=[baseurl]/help/hook/html2bb_video]html2bb_video[/zrl]
+ Called when using the html2bbcode translation to handle embedded media
+
[zrl=[baseurl]/help/hook/html2bbcode]html2bbcode[/zrl]
- Called when using the html2bbcode tranlsation
+ Called when using the html2bbcode translation
[zrl=[baseurl]/help/hook/identity_basic_export]identity_basic_export[/zrl]
Called when exporting a channel's basic information for backup or transfer
diff --git a/include/PermissionDescription.php b/include/PermissionDescription.php
new file mode 100644
index 000000000..75dd9ecf7
--- /dev/null
+++ b/include/PermissionDescription.php
@@ -0,0 +1,178 @@
+global_perm = $global_perm;
+ $this->channel_perm = $channel_perm;
+
+ $this->fallback_description = ($description == '') ? t('Visible to your default audience') : $description;
+ }
+
+ /**
+ * If the interpretation of an empty ACL can't be summarised with a global default permission
+ * or a specific permission setting then use this method and describe what it means instead.
+ * Remember to localize the description first.
+ *
+ * @param string $description - the localized caption for the no-ACL option in the ACL dialog.
+ * @return a new instance of PermissionDescription
+ */
+ public static function fromDescription($description) {
+ return new PermissionDescription('', 0x80000, $description);
+ }
+
+
+ /**
+ * Use this method only if the interpretation of an empty ACL doesn't fall back to a global
+ * default permission. You should pass one of the constants from boot.php - PERMS_PUBLIC,
+ * PERMS_NETWORK etc.
+ *
+ * @param integer $perm - a single enumerated constant permission - PERMS_PUBLIC, PERMS_NETWORK etc.
+ * @return a new instance of PermissionDescription
+ */
+ public static function fromStandalonePermission($perm) {
+
+ $result = new PermissionDescription('', $perm);
+
+ $checkPerm = $this->get_permission_description();
+ if ($checkPerm == $this->fallback_description) {
+ $result = null;
+ logger('null PermissionDescription from unknown standalone permission: ' . $perm ,LOGGER_DEBUG, LOG_ERROR);
+ }
+
+ return $result;
+ }
+
+ /**
+ * This is the preferred way to create a PermissionDescription, as it provides the most details.
+ * Use this method if you know an empty ACL will result in one of the global default permissions
+ * being used, such as channel_r_stream (for which you would pass 'view_stream').
+ *
+ * @param string $permname - a key for the global perms array from get_perms() in permissions.php,
+ * e.g. 'view_stream', 'view_profile', etc.
+ * @return a new instance of PermissionDescription
+ */
+ public static function fromGlobalPermission($permname) {
+
+ $result = null;
+
+ $global_perms = get_perms();
+
+ if (array_key_exists($permname, $global_perms)) {
+
+ $permDetails = $global_perms[$permname];
+
+ // It should be OK to always just read the permissions from App::$channel
+ //
+ // App::$profile is a union of channel and profile fields.
+ // The distinction is basically that App::$profile is pointing to the resource
+ // being observed. App::$channel is referring to the current logged-in channel
+ // member (if this is a local channel) e.g. the observer. We only show the ACL
+ // widget to the page owner (observer and observed are the same) so in that case
+ // I believe either may be safely used here.
+ $channelPerm = \App::$channel[$permDetails[0]];
+ $result = new PermissionDescription($permDetails[1], $channelPerm);
+ } else {
+ // The acl dialog can handle null arguments, but it shouldn't happen
+ logger('null PermissionDescription from unknown global permission: ' . $permname ,LOGGER_DEBUG, LOG_ERROR);
+ }
+ return $result;
+ }
+
+
+ /**
+ * Gets a localized description of the permission, or a generic message if the permission
+ * is unknown.
+ *
+ * @return string description
+ */
+ public function get_permission_description() {
+
+ switch($this->channel_perm) {
+
+ case 0: return t('Only me');
+ case PERMS_PUBLIC: return t('Public');
+ case PERMS_NETWORK: return t('Anybody in the $Projectname network');
+ case PERMS_SITE: return sprintf(t('Any account on %s'), \App::get_hostname());
+ case PERMS_CONTACTS: return t('Any of my connections');
+ case PERMS_SPECIFIC:
+ // Because we're describing the permissions of an item with an empty ACL,
+ // the owner will be the only person able to see it if the permissions are
+ // set to "only specified connections".
+ return t('Only me (only specified contacts and me)');
+ case PERMS_AUTHED: return t('Anybody authenticated (could include visitors from other networks)');
+ case PERMS_PENDING: return t('Any connections including those who haven\'t yet been approved');
+ default: return $this->fallback_description;
+ }
+ }
+
+ /**
+ * Returns an icon css class name if an appropriate one is available, e.g. "fa-globe" for Public,
+ * otherwise returns empty string.
+ *
+ * @return string icon css class name (often FontAwesome)
+ */
+ public function get_permission_icon() {
+
+ switch($this->channel_perm) {
+
+ case 0:/* only me */ return 'fa-eye-slash';
+ case PERMS_PUBLIC: return 'fa-globe';
+ case PERMS_NETWORK: return 'fa-share-alt-square'; // fa-share-alt-square is very similiar to the hubzilla logo, but we should create our own logo class to use
+ case PERMS_SITE: return 'fa-sitemap';
+ case PERMS_CONTACTS: return 'fa-group';
+ case PERMS_SPECIFIC:
+ // Because we're describing the permissions of an item with an empty ACL,
+ // the owner will be the only person able to see it if the permissions are
+ // set to "only specified connections".
+ return 'fa-eye-slash';
+ case PERMS_AUTHED: return '';
+ case PERMS_PENDING: return '';
+ default: return '';
+ }
+ }
+
+
+ /**
+ * Returns a localized description of where the permission came from, if this is known.
+ * If it's not know, or if the permission is standalone and didn't come from a default
+ * permission setting, then empty string is returned.
+ *
+ * @return string description or empty string
+ */
+ public function get_permission_origin_description() {
+
+ switch($this->global_perm) {
+
+ case PERMS_R_STREAM: return t('This is your default setting for the audience of your normal stream, and posts.');
+ case PERMS_R_PROFILE: return t('This is your default setting for who can view your default channel profile');
+ case PERMS_R_ABOOK: return t('This is your default setting for who can view your connections');
+ case PERMS_R_STORAGE: return t('This is your default setting for who can view your file storage and photos');
+ case PERMS_R_PAGES: return t('This is your default setting for the audience of your webpages');
+ default: return '';
+ }
+ }
+
+}
diff --git a/include/acl_selectors.php b/include/acl_selectors.php
index 4cc01d15b..ce0a32798 100644
--- a/include/acl_selectors.php
+++ b/include/acl_selectors.php
@@ -6,6 +6,9 @@
/**
* @package acl_selectors
*/
+
+require_once("include/PermissionDescription.php");
+
function group_select($selname,$selclass,$preselected = false,$size = 4) {
$a = get_app();
@@ -215,20 +218,34 @@ function fixacl(&$item) {
*
* @param array $default Optional access control list for the initial state of the dialog.
* @param boolean $show_jotnets Whether plugins for federated networks should be included in the permissions dialog
-* @param string $showall_caption An optional caption to describe the scope of an unrestricted post. e.g. "Public"
+* @param PermissionDescription $emptyACL_description - An optional description for the permission implied by selecting an empty ACL. Preferably an instance of PermissionDescription.
* @param string $dialog_description Optional message to include at the top of the dialog. E.g. "Warning: Post permissions cannot be changed once sent".
* @param string $context_help Allows the dialog to present a help icon. E.g. "acl_dialog_post"
* @param boolean $readonly Not implemented yet. When implemented, the dialog will use acl_readonly.tpl instead, so that permissions may be viewed for posts that can no longer have their permissions changed.
*
* @return string html modal dialog built from acl_selector.tpl
*/
-function populate_acl($defaults = null,$show_jotnets = true, $showall_caption = '', $dialog_description = '', $context_help = '', $readonly = false) {
+function populate_acl($defaults = null,$show_jotnets = true, $emptyACL_description = '', $dialog_description = '', $context_help = '', $readonly = false) {
$allow_cid = $allow_gid = $deny_cid = $deny_gid = false;
+ $showall_origin = '';
+ $showall_icon = 'fa-globe';
- if(! $showall_caption)
+
+ if(! $emptyACL_description) {
$showall_caption = t('Visible to your default audience');
+ } else if (is_a($emptyACL_description, 'PermissionDescription')) {
+ $showall_caption = $emptyACL_description->get_permission_description();
+ $showall_origin = $emptyACL_description->get_permission_origin_description();
+ $showall_icon = $emptyACL_description->get_permission_icon();
+
+ } else {
+ // For backwards compatibility we still accept a string... for now!
+ $showall_caption = $emptyACL_description;
+ }
+
+
if(is_array($defaults)) {
$allow_cid = ((strlen($defaults['allow_cid']))
? explode('><', $defaults['allow_cid']) : array() );
@@ -252,6 +269,8 @@ function populate_acl($defaults = null,$show_jotnets = true, $showall_caption =
$tpl = get_markup_template("acl_selector.tpl");
$o = replace_macros($tpl, array(
'$showall' => $showall_caption,
+ '$showallOrigin' => $showall_origin,
+ '$showallIcon' => $showall_icon,
'$showlimited' => t("Limit access:"),
'$showlimitedDesc' => t('Select "Show" to allow viewing. "Don\'t show" lets you override and limit the scope of "Show".'),
'$show' => t("Show"),
@@ -278,7 +297,7 @@ function populate_acl($defaults = null,$show_jotnets = true, $showall_caption =
* populate_acl() call for wall posts or network posts.
*
* This string is needed in 3 different files, and our .po translation system currently
-* cannot be used as a string table (because the value is always the key is english) so
+* cannot be used as a string table (because the value is always the key in english) so
* I've centralized the value here (making this function name the "key") until we have a
* better way.
*
diff --git a/include/bbcode.php b/include/bbcode.php
index 7a7ea8ce6..fd2d2f97a 100644
--- a/include/bbcode.php
+++ b/include/bbcode.php
@@ -492,18 +492,6 @@ function bb_observer($Text) {
function bbcode($Text, $preserve_nl = false, $tryoembed = true, $cache = false) {
- $a = get_app();
-
- // Move all spaces out of the tags
- // ....Uhm why?
- // This is basically doing a trim() on the stuff in between tags, but it messes up
- // carefully crafted bbcode and especially other pre-formatted code.
- // Commenting out until we come up with a use case where it's needed. Then let's try and
- // special case rather than a heavy-handed approach like this.
-
-// $Text = preg_replace("/\[(\w*)\](\s*)/ism", '$2[$1]', $Text);
-// $Text = preg_replace("/(\s*)\[\/(\w*)\]/ism", '[/$2]$1', $Text);
-
// Hide all [noparse] contained bbtags by spacefying them
if (strpos($Text,'[noparse]') !== false) {
$Text = preg_replace_callback("/\[noparse\](.*?)\[\/noparse\]/ism", 'bb_spacefy',$Text);
@@ -834,9 +822,6 @@ function bbcode($Text, $preserve_nl = false, $tryoembed = true, $cache = false)
}
-
-
-
// Declare the format for [quote] layout
$QuoteLayout = '