src/Content/Feature.php

   1 <?php
   2 /**
   3  * @file src/Content/Feature.php
   4  * @brief Features management
   5  */
   6 namespace Friendica\Content;
   7
   8 use Friendica\Core\Addon;
   9 use Friendica\Core\Config;
  10 use Friendica\Core\L10n;
  11 use Friendica\Core\PConfig;
  12
  13 class Feature
  14 {
  15         /**
  16          * @brief check if feature is enabled
  17          *
  18          * @param integer $uid     user id
  19          * @param string  $feature feature
  20          * @return boolean
  21          */
  22         public static function isEnabled($uid, $feature)
  23         {
  24                 $x = Config::get('feature_lock', $feature, false);
  25
  26                 if ($x === false) {
  27                         $x = PConfig::get($uid, 'feature', $feature, false);
  28                 }
  29
  30                 if ($x === false) {
  31                         $x = Config::get('feature', $feature, false);
  32                 }
  33
  34                 if ($x === false) {
  35                         $x = self::getDefault($feature);
  36                 }
  37
  38                 $arr = ['uid' => $uid, 'feature' => $feature, 'enabled' => $x];
  39                 Addon::callHooks('isEnabled', $arr);
  40                 return($arr['enabled']);
  41         }
  42
  43         /**
  44          * @brief check if feature is enabled or disabled by default
  45          *
  46          * @param string $feature feature
  47          * @return boolean
  48          */
  49         private static function getDefault($feature)
  50         {
  51                 $f = self::get();
  52                 foreach ($f as $cat) {
  53                         foreach ($cat as $feat) {
  54                                 if (is_array($feat) && $feat[0] === $feature) {
  55                                         return $feat[3];
  56                                 }
  57                         }
  58                 }
  59                 return false;
  60         }
  61
  62         /**
  63          * @brief Get a list of all available features
  64          *
  65          * The array includes the setting group, the setting name,
  66          * explainations for the setting and if it's enabled or disabled
  67          * by default
  68          *
  69          * @param bool $filtered True removes any locked features
  70          *
  71          * @return array
  72          */
  73         public static function get($filtered = true)
  74         {
  75                 $arr = [
  76
  77                         // General
  78                         'general' => [
  79                                 L10n::t('General Features'),
  80                                 //array('expire',         L10n::t('Content Expiration'),                L10n::t('Remove old posts/comments after a period of time')),
  81                                 ['multi_profiles',  L10n::t('Multiple Profiles'),      L10n::t('Ability to create multiple profiles'), false, Config::get('feature_lock', 'multi_profiles', false)],
  82                                 ['photo_location',  L10n::t('Photo Location'),         L10n::t("Photo metadata is normally stripped. This extracts the location \x28if present\x29 prior to stripping metadata and links it to a map."), false, Config::get('feature_lock', 'photo_location', false)],
  83                                 ['export_calendar', L10n::t('Export Public Calendar'), L10n::t('Ability for visitors to download the public calendar'), false, Config::get('feature_lock', 'export_calendar', false)],
  84                         ],
  85
  86                         // Post composition
  87                         'composition' => [
  88                                 L10n::t('Post Composition Features'),
  89                                 ['preview',        L10n::t('Post Preview'),        L10n::t('Allow previewing posts and comments before publishing them'), false, Config::get('feature_lock', 'preview', false)],
  90                                 ['aclautomention', L10n::t('Auto-mention Forums'), L10n::t('Add/remove mention when a forum page is selected/deselected in ACL window.'), false, Config::get('feature_lock', 'aclautomention', false)],
  91                         ],
  92
  93                         // Network sidebar widgets
  94                         'widgets' => [
  95                                 L10n::t('Network Sidebar'),
  96                                 ['archives',         L10n::t('Archives'), L10n::t('Ability to select posts by date ranges'), false, Config::get('feature_lock', 'archives', false)],
  97                                 ['forumlist_widget', L10n::t('List Forums'),    L10n::t('Enable widget to display the forums your are connected with'), true, Config::get('feature_lock', 'forumlist_widget', false)],
  98                                 ['groups',           L10n::t('Group Filter'),   L10n::t('Enable widget to display Network posts only from selected group'), false, Config::get('feature_lock', 'groups', false)],
  99                                 ['networks',         L10n::t('Network Filter'), L10n::t('Enable widget to display Network posts only from selected network'), false, Config::get('feature_lock', 'networks', false)],
 100                                 ['savedsearch',      L10n::t('Saved Searches'), L10n::t('Save search terms for re-use'), false, Config::get('feature_lock', 'savedsearch', false)],
 101                         ],
 102
 103                         // Network tabs
 104                         'net_tabs' => [
 105                                 L10n::t('Network Tabs'),
 106                                 ['personal_tab', L10n::t('Network Personal Tab'),     L10n::t('Enable tab to display only Network posts that you\'ve interacted on'), false, Config::get('feature_lock', 'personal_tab', false)],
 107                                 ['new_tab',      L10n::t('Network New Tab'),          L10n::t("Enable tab to display only new Network posts \x28from the last 12 hours\x29"), false, Config::get('feature_lock', 'new_tab', false)],
 108                                 ['link_tab',     L10n::t('Network Shared Links Tab'), L10n::t('Enable tab to display only Network posts with links in them'), false, Config::get('feature_lock', 'link_tab', false)],
 109                         ],
 110
 111                         // Item tools
 112                         'tools' => [
 113                                 L10n::t('Post/Comment Tools'),
 114                                 ['multi_delete', L10n::t('Multiple Deletion'),       L10n::t('Select and delete multiple posts/comments at once'), false, Config::get('feature_lock', 'multi_delete', false)],
 115                                 ['edit_posts',   L10n::t('Edit Sent Posts'),         L10n::t('Edit and correct posts and comments after sending'), false, Config::get('feature_lock', 'edit_posts', false)],
 116                                 ['commtag',      L10n::t('Tagging'),                 L10n::t('Ability to tag existing posts'), false, Config::get('feature_lock', 'commtag', false)],
 117                                 ['categories',   L10n::t('Post Categories'),         L10n::t('Add categories to your posts'), false, Config::get('feature_lock', 'categories', false)],
 118                                 ['filing',       L10n::t('Saved Folders'),           L10n::t('Ability to file posts under folders'), false, Config::get('feature_lock', 'filing', false)],
 119                                 ['dislike',      L10n::t('Dislike Posts'),           L10n::t('Ability to dislike posts/comments'), false, Config::get('feature_lock', 'dislike', false)],
 120                                 ['star_posts',   L10n::t('Star Posts'),              L10n::t('Ability to mark special posts with a star indicator'), false, Config::get('feature_lock', 'star_posts', false)],
 121                                 ['ignore_posts', L10n::t('Mute Post Notifications'), L10n::t('Ability to mute notifications for a thread'), false, Config::get('feature_lock', 'ignore_posts', false)],
 122                         ],
 123
 124                         // Advanced Profile Settings
 125                         'advanced_profile' => [
 126                                 L10n::t('Advanced Profile Settings'),
 127                                 ['forumlist_profile',   L10n::t('List Forums'),             L10n::t('Show visitors public community forums at the Advanced Profile Page'), false, Config::get('feature_lock', 'forumlist_profile', false)],
 128                                 ['tagadelic',           L10n::t('Tag Cloud'),               L10n::t('Provide a personal tag cloud on your profile page'), false, Config::get('feature_lock', 'tagadelic', false)],
 129                                 ['profile_membersince', L10n::t('Display Membership Date'), L10n::t('Display membership date in profile'), false, Config::get('feature_lock', 'profile_membersince', false)],
 130                         ],
 131                 ];
 132
 133                 // removed any locked features and remove the entire category if this makes it empty
 134
 135                 if ($filtered) {
 136                         foreach ($arr as $k => $x) {
 137                                 $has_items = false;
 138                                 $kquantity = count($arr[$k]);
 139                                 for ($y = 0; $y < $kquantity; $y ++) {
 140                                         if (is_array($arr[$k][$y])) {
 141                                                 if ($arr[$k][$y][4] === false) {
 142                                                         $has_items = true;
 143                                                 } else {
 144                                                         unset($arr[$k][$y]);
 145                                                 }
 146                                         }
 147                                 }
 148                                 if (! $has_items) {
 149                                         unset($arr[$k]);
 150                                 }
 151                         }
 152                 }
 153
 154                 Addon::callHooks('get', $arr);
 155                 return $arr;
 156         }
 157 }