langfilter/langfilter.php

   1 <?php
   2 /*
   3  * Name: Language Filter
   4  * Version: 0.1
   5  * Description: Filters out postings in languages not spoken by the users
   6  * Author: Tobias Diekershoff <https://f.diekershoff.de/u/tobias>
   7  * License: MIT
   8  */
   9
  10 use Friendica\App;
  11 use Friendica\Core\Addon;
  12 use Friendica\Core\L10n;
  13 use Friendica\Core\PConfig;
  14
  15 /* Define the hooks we want to use
  16  * that is, we have settings, we need to save the settings and we want
  17  * to modify the content of a posting when friendica prepares it.
  18  */
  19
  20 function langfilter_install()
  21 {
  22         Addon::registerHook('prepare_body_content_filter', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body_content_filter', 10);
  23         Addon::registerHook('addon_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
  24         Addon::registerHook('addon_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
  25 }
  26
  27 function langfilter_uninstall()
  28 {
  29         Addon::unregisterHook('prepare_body_content_filter', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body_content_filter');
  30         Addon::unregisterHook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body');
  31         Addon::unregisterHook('addon_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
  32         Addon::unregisterHook('addon_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
  33 }
  34
  35 /* The settings
  36  * 1st check if somebody logged in is calling
  37  * 2nd get the current settings
  38  * 3rd parse a SMARTY3 template, replacing some translateable strings for the form
  39  */
  40
  41 function langfilter_addon_settings(App $a, &$s)
  42 {
  43         if (!local_user()) {
  44                 return;
  45         }
  46
  47         $enable_checked = (intval(PConfig::get(local_user(), 'langfilter', 'disable')) ? '' : ' checked="checked" ');
  48         $languages      = PConfig::get(local_user(), 'langfilter', 'languages');
  49         $minconfidence  = PConfig::get(local_user(), 'langfilter', 'minconfidence') * 100;
  50         $minlength      = PConfig::get(local_user(), 'langfilter', 'minlength');
  51
  52         if (!$languages) {
  53                 $languages = 'en,de,fr,it,es';
  54         }
  55
  56         $t = get_markup_template("settings.tpl", "addon/langfilter/");
  57         $s .= replace_macros($t, [
  58                 '$title'         => L10n::t("Language Filter"),
  59                 '$intro'         => L10n::t('This addon tries to identify the language posts are writen in. If it does not match any language specifed below, posts will be hidden by collapsing them.'),
  60                 '$enabled'       => ['langfilter_enable', L10n::t('Use the language filter'), $enable_checked, ''],
  61                 '$languages'     => ['langfilter_languages', L10n::t('Able to read'), $languages, L10n::t('List of abbreviations (iso2 codes) for languages you speak, comma separated. For example "de,it".')],
  62                 '$minconfidence' => ['langfilter_minconfidence', L10n::t('Minimum confidence in language detection'), $minconfidence, L10n::t('Minimum confidence in language detection being correct, from 0 to 100. Posts will not be filtered when the confidence of language detection is below this percent value.')],
  63                 '$minlength'     => ['langfilter_minlength', L10n::t('Minimum length of message body'), $minlength, L10n::t('Minimum number of characters in message body for filter to be used. Posts shorter than this will not be filtered. Note: Language detection is unreliable for short content (<200 characters).')],
  64                 '$submit'        => L10n::t('Save Settings'),
  65         ]);
  66
  67         return;
  68 }
  69
  70 /* Save the settings
  71  * 1st check it's a logged in user calling
  72  * 2nd check the langfilter form is to be saved
  73  * 3rd save the settings to the DB for later usage
  74  */
  75
  76 function langfilter_addon_settings_post(App $a, &$b)
  77 {
  78         if (!local_user()) {
  79                 return;
  80         }
  81
  82         if ($_POST['langfilter-settings-submit']) {
  83                 PConfig::set(local_user(), 'langfilter', 'languages', trim($_POST['langfilter_languages']));
  84                 $enable = ((x($_POST, 'langfilter_enable')) ? intval($_POST['langfilter_enable']) : 0);
  85                 $disable = 1 - $enable;
  86                 PConfig::set(local_user(), 'langfilter', 'disable', $disable);
  87                 $minconfidence = 0 + $_POST['langfilter_minconfidence'];
  88                 if (!$minconfidence) {
  89                         $minconfidence = 0;
  90                 } elseif ($minconfidence < 0) {
  91                         $minconfidence = 0;
  92                 } elseif ($minconfidence > 100) {
  93                         $minconfidence = 100;
  94                 }
  95                 PConfig::set(local_user(), 'langfilter', 'minconfidence', $minconfidence / 100.0);
  96
  97                 $minlength = 0 + $_POST['langfilter_minlength'];
  98                 if (!$minlength) {
  99                         $minlength = 32;
 100                 } elseif ($minlengt8h < 0) {
 101                         $minlength = 32;
 102                 }
 103                 PConfig::set(local_user(), 'langfilter', 'minlength', $minlength);
 104
 105                 info(L10n::t('Language Filter Settings saved.') . EOL);
 106         }
 107 }
 108
 109 /* Actually filter postings by their language
 110  * 1st check if the user wants to filter postings
 111  * 2nd get the user settings which languages shall be not filtered out
 112  * 3rd extract the language of a posting
 113  * 4th if the determined language does not fit to the spoken languages
 114  *     of the user, then collapse the posting, but provide a link to
 115  *     expand it again.
 116  */
 117
 118 function langfilter_prepare_body_content_filter(App $a, &$hook_data)
 119 {
 120         $logged_user = local_user();
 121         if (!$logged_user) {
 122                 return;
 123         }
 124
 125         // Never filter own messages
 126         // TODO: find a better way to extract this
 127         $logged_user_profile = $a->get_baseurl() . '/profile/' . $a->user['nickname'];
 128         if ($logged_user_profile == $hook_data['item']['author-link']) {
 129                 return;
 130         }
 131
 132         // Don't filter if language filter is disabled
 133         if (PConfig::get($logged_user, 'langfilter', 'disable')) {
 134                 return;
 135         }
 136
 137         // Don't filter if body lenght is below minimum
 138         $minlen = PConfig::get(local_user(), 'langfilter', 'minlength');
 139         if (!$minlen) {
 140                 $minlen = 32;
 141         }
 142         if (strlen($hook_data['item']['body']) < $minlen) {
 143                 return;
 144         }
 145
 146         $read_languages_string = PConfig::get(local_user(), 'langfilter', 'languages');
 147         $minconfidence = PConfig::get(local_user(), 'langfilter', 'minconfidence');
 148
 149         // Don't filter if no spoken languages are configured
 150         if (!$read_languages_string) {
 151                 return;
 152         }
 153         $read_languages_array = explode(',', $read_languages_string);
 154
 155         // Extract the language of the post
 156         $opts = $hook_data['item']['postopts'];
 157         if (!$opts) {
 158                 // no options associated to post
 159                 return;
 160         }
 161
 162         if (!preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches)) {
 163                 // no lang options associated to post
 164                 return;
 165         }
 166
 167         $lang = $matches[1];
 168         $confidence = $matches[2];
 169
 170         // Do not filter if language detection confidence is too low
 171         if ($minconfidence && $confidence < $minconfidence) {
 172                 return;
 173         }
 174
 175         $iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang);
 176
 177         if (!$iso2) {
 178                 return;
 179         }
 180
 181         if (!in_array($iso2, $read_languages_array)) {
 182                 $hook_data['filter_reasons'][] = L10n::t('Filtered language: %s', ucfirst($lang));
 183         }
 184 }