src/Content/Feature.php

   1 <?php
   2 /**
   3  * @file src/Content/Feature.php
   4  * Features management
   5  */
   6 namespace Friendica\Content;
   7
   8 use Friendica\Core\Config;
   9 use Friendica\Core\Hook;
  10 use Friendica\DI;
  11
  12 class Feature
  13 {
  14         /**
  15          * check if feature is enabled
  16          *
  17          * @param integer $uid     user id
  18          * @param string  $feature feature
  19          * @return boolean
  20          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  21          */
  22         public static function isEnabled(int $uid, $feature)
  23         {
  24                 $x = DI::config()->get('feature_lock', $feature, false);
  25
  26                 if ($x === false) {
  27                         $x = DI::pConfig()->get($uid, 'feature', $feature, false);
  28                 }
  29
  30                 if ($x === false) {
  31                         $x = DI::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                 Hook::callAll('isEnabled', $arr);
  40                 return($arr['enabled']);
  41         }
  42
  43         /**
  44          * check if feature is enabled or disabled by default
  45          *
  46          * @param string $feature feature
  47          * @return boolean
  48          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  49          */
  50         private static function getDefault($feature)
  51         {
  52                 $f = self::get();
  53                 foreach ($f as $cat) {
  54                         foreach ($cat as $feat) {
  55                                 if (is_array($feat) && $feat[0] === $feature) {
  56                                         return $feat[3];
  57                                 }
  58                         }
  59                 }
  60                 return false;
  61         }
  62
  63         /**
  64          * Get a list of all available features
  65          *
  66          * The array includes the setting group, the setting name,
  67          * explainations for the setting and if it's enabled or disabled
  68          * by default
  69          *
  70          * @param bool $filtered True removes any locked features
  71          *
  72          * @return array
  73          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  74          */
  75         public static function get($filtered = true)
  76         {
  77                 $arr = [
  78
  79                         // General
  80                         'general' => [
  81                                 DI::l10n()->t('General Features'),
  82                                 //array('expire',         DI::l10n()->t('Content Expiration'),          DI::l10n()->t('Remove old posts/comments after a period of time')),
  83                                 ['multi_profiles',  DI::l10n()->t('Multiple Profiles'),      DI::l10n()->t('Ability to create multiple profiles'), false, DI::config()->get('feature_lock', 'multi_profiles', false)],
  84                                 ['photo_location',  DI::l10n()->t('Photo Location'),         DI::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, DI::config()->get('feature_lock', 'photo_location', false)],
  85                                 ['export_calendar', DI::l10n()->t('Export Public Calendar'), DI::l10n()->t('Ability for visitors to download the public calendar'), false, DI::config()->get('feature_lock', 'export_calendar', false)],
  86                                 ['trending_tags',   DI::l10n()->t('Trending Tags'),          DI::l10n()->t('Show a community page widget with a list of the most popular tags in recent public posts.'), false, DI::config()->get('feature_lock', 'trending_tags', false)],
  87                         ],
  88
  89                         // Post composition
  90                         'composition' => [
  91                                 DI::l10n()->t('Post Composition Features'),
  92                                 ['aclautomention', DI::l10n()->t('Auto-mention Forums'), DI::l10n()->t('Add/remove mention when a forum page is selected/deselected in ACL window.'), false, DI::config()->get('feature_lock', 'aclautomention', false)],
  93                                 ['explicit_mentions', DI::l10n()->t('Explicit Mentions'), DI::l10n()->t('Add explicit mentions to comment box for manual control over who gets mentioned in replies.'), false, DI::config()->get('feature_lock', 'explicit_mentions', false)],
  94                         ],
  95
  96                         // Network sidebar widgets
  97                         'widgets' => [
  98                                 DI::l10n()->t('Network Sidebar'),
  99                                 ['archives',         DI::l10n()->t('Archives'), DI::l10n()->t('Ability to select posts by date ranges'), false, DI::config()->get('feature_lock', 'archives', false)],
 100                                 ['networks',         DI::l10n()->t('Protocol Filter'), DI::l10n()->t('Enable widget to display Network posts only from selected protocols'), false, DI::config()->get('feature_lock', 'networks', false)],
 101                         ],
 102
 103                         // Network tabs
 104                         'net_tabs' => [
 105                                 DI::l10n()->t('Network Tabs'),
 106                                 ['new_tab',      DI::l10n()->t('Network New Tab'),          DI::l10n()->t("Enable tab to display only new Network posts \x28from the last 12 hours\x29"), false, DI::config()->get('feature_lock', 'new_tab', false)],
 107                                 ['link_tab',     DI::l10n()->t('Network Shared Links Tab'), DI::l10n()->t('Enable tab to display only Network posts with links in them'), false, DI::config()->get('feature_lock', 'link_tab', false)],
 108                         ],
 109
 110                         // Item tools
 111                         'tools' => [
 112                                 DI::l10n()->t('Post/Comment Tools'),
 113                                 ['categories',   DI::l10n()->t('Post Categories'),         DI::l10n()->t('Add categories to your posts'), false, DI::config()->get('feature_lock', 'categories', false)],
 114                         ],
 115
 116                         // Advanced Profile Settings
 117                         'advanced_profile' => [
 118                                 DI::l10n()->t('Advanced Profile Settings'),
 119                                 ['forumlist_profile',   DI::l10n()->t('List Forums'),             DI::l10n()->t('Show visitors public community forums at the Advanced Profile Page'), false, DI::config()->get('feature_lock', 'forumlist_profile', false)],
 120                                 ['tagadelic',           DI::l10n()->t('Tag Cloud'),               DI::l10n()->t('Provide a personal tag cloud on your profile page'), false, DI::config()->get('feature_lock', 'tagadelic', false)],
 121                                 ['profile_membersince', DI::l10n()->t('Display Membership Date'), DI::l10n()->t('Display membership date in profile'), false, DI::config()->get('feature_lock', 'profile_membersince', false)],
 122                         ],
 123                 ];
 124
 125                 // removed any locked features and remove the entire category if this makes it empty
 126
 127                 if ($filtered) {
 128                         foreach ($arr as $k => $x) {
 129                                 $has_items = false;
 130                                 $kquantity = count($arr[$k]);
 131                                 for ($y = 0; $y < $kquantity; $y ++) {
 132                                         if (is_array($arr[$k][$y])) {
 133                                                 if ($arr[$k][$y][4] === false) {
 134                                                         $has_items = true;
 135                                                 } else {
 136                                                         unset($arr[$k][$y]);
 137                                                 }
 138                                         }
 139                                 }
 140                                 if (! $has_items) {
 141                                         unset($arr[$k]);
 142                                 }
 143                         }
 144                 }
 145
 146                 Hook::callAll('get', $arr);
 147                 return $arr;
 148         }
 149 }