include/features.php

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