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\Content\Text\BBCode;
  12 use Friendica\Core\Hook;
  13 use Friendica\Core\Renderer;
  14 use Friendica\DI;
  15
  16 /* Define the hooks we want to use
  17  * that is, we have settings, we need to save the settings and we want
  18  * to modify the content of a posting when friendica prepares it.
  19  */
  20
  21 function langfilter_install()
  22 {
  23         Hook::register('prepare_body_content_filter', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body_content_filter', 10);
  24         Hook::register('addon_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
  25         Hook::register('addon_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
  26 }
  27
  28 /* The settings
  29  * 1st check if somebody logged in is calling
  30  * 2nd get the current settings
  31  * 3rd parse a SMARTY3 template, replacing some translateable strings for the form
  32  */
  33
  34 function langfilter_addon_settings(App $a, &$s)
  35 {
  36         if (!local_user()) {
  37                 return;
  38         }
  39
  40         $enabled = DI::pConfig()->get(local_user(), 'langfilter', 'enable',
  41                 !DI::pConfig()->get(local_user(), 'langfilter', 'disable'));
  42
  43         $enable_checked = $enabled ? ' checked="checked"' : '';
  44         $languages      = DI::pConfig()->get(local_user(), 'langfilter', 'languages');
  45         $minconfidence  = DI::pConfig()->get(local_user(), 'langfilter', 'minconfidence', 0) * 100;
  46         $minlength      = DI::pConfig()->get(local_user(), 'langfilter', 'minlength'    , 32);
  47
  48         $t = Renderer::getMarkupTemplate("settings.tpl", "addon/langfilter/");
  49         $s .= Renderer::replaceMacros($t, [
  50                 '$title'         => DI::l10n()->t("Language Filter"),
  51                 '$intro'         => DI::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.'),
  52                 '$enabled'       => ['langfilter_enable', DI::l10n()->t('Use the language filter'), $enable_checked, ''],
  53                 '$languages'     => ['langfilter_languages', DI::l10n()->t('Able to read'), $languages, DI::l10n()->t('List of abbreviations (iso2 codes) for languages you speak, comma separated. For example "de,it".')],
  54                 '$minconfidence' => ['langfilter_minconfidence', DI::l10n()->t('Minimum confidence in language detection'), $minconfidence, DI::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.')],
  55                 '$minlength'     => ['langfilter_minlength', DI::l10n()->t('Minimum length of message body'), $minlength, DI::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).')],
  56                 '$submit'        => DI::l10n()->t('Save Settings'),
  57         ]);
  58
  59         return;
  60 }
  61
  62 /* Save the settings
  63  * 1st check it's a logged in user calling
  64  * 2nd check the langfilter form is to be saved
  65  * 3rd save the settings to the DB for later usage
  66  */
  67
  68 function langfilter_addon_settings_post(App $a, &$b)
  69 {
  70         if (!local_user()) {
  71                 return;
  72         }
  73
  74         if (!empty($_POST['langfilter-settings-submit'])) {
  75                 $enable        = intval($_POST['langfilter_enable'] ?? 0);
  76                 $languages     = trim($_POST['langfilter_languages'] ?? '');
  77                 $minconfidence = max(0, min(100, intval($_POST['langfilter_minconfidence'] ?? 0))) / 100;
  78                 $minlength     = intval($_POST['langfilter_minlength'] ?? 32);
  79                 if ($minlength <= 0) {
  80                         $minlength = 32;
  81                 }
  82
  83                 DI::pConfig()->set(local_user(), 'langfilter', 'enable'       , $enable);
  84                 DI::pConfig()->set(local_user(), 'langfilter', 'languages'    , $languages);
  85                 DI::pConfig()->set(local_user(), 'langfilter', 'minconfidence', $minconfidence);
  86                 DI::pConfig()->set(local_user(), 'langfilter', 'minlength'    , $minlength);
  87         }
  88 }
  89
  90 /* Actually filter postings by their language
  91  * 1st check if the user wants to filter postings
  92  * 2nd get the user settings which languages shall be not filtered out
  93  * 3rd extract the language of a posting
  94  * 4th if the determined language does not fit to the spoken languages
  95  *     of the user, then collapse the posting, but provide a link to
  96  *     expand it again.
  97  */
  98
  99 function langfilter_prepare_body_content_filter(App $a, &$hook_data)
 100 {
 101         $logged_user = local_user();
 102         if (!$logged_user) {
 103                 return;
 104         }
 105
 106         // Never filter own messages
 107         // TODO: find a better way to extract this
 108         $logged_user_profile = DI::baseUrl()->get() . '/profile/' . $a->user['nickname'];
 109         if ($logged_user_profile == $hook_data['item']['author-link']) {
 110                 return;
 111         }
 112
 113         // Don't filter if language filter is disabled
 114         if (!DI::pConfig()->get($logged_user, 'langfilter', 'enable',
 115                 !DI::pConfig()->get($logged_user, 'langfilter', 'disable'))
 116         ) {
 117                 return;
 118         }
 119
 120         $naked_body = BBCode::toPlaintext($hook_data['item']['body'], false);
 121
 122         // Don't filter if body lenght is below minimum
 123         $minlen = DI::pConfig()->get(local_user(), 'langfilter', 'minlength', 32);
 124         if (!$minlen) {
 125                 $minlen = 32;
 126         }
 127
 128         if (strlen($naked_body) < $minlen) {
 129                 return;
 130         }
 131
 132         $read_languages_string = DI::pConfig()->get(local_user(), 'langfilter', 'languages');
 133         $minconfidence = DI::pConfig()->get(local_user(), 'langfilter', 'minconfidence');
 134
 135         // Don't filter if no spoken languages are configured
 136         if (!$read_languages_string) {
 137                 return;
 138         }
 139         $read_languages_array = explode(',', $read_languages_string);
 140
 141         // Extract the language of the post
 142         if (!empty($hook_data['item']['language'])) {
 143                 $languages = json_decode($hook_data['item']['language'], true);
 144                 if (!is_array($languages)) {
 145                         return;
 146                 }
 147
 148                 foreach ($languages as $iso2 => $confidence) {
 149                         break;
 150                 }
 151
 152                 if (empty($iso2)) {
 153                         return;
 154                 }
 155
 156                 $lang = Text_LanguageDetect_ISO639::code2ToName($iso2);
 157         } else {
 158                 $opts = $hook_data['item']['postopts'];
 159                 if (!$opts) {
 160                         // no options associated to post
 161                         return;
 162                 }
 163
 164                 if (!preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches)) {
 165                         // no lang options associated to post
 166                         return;
 167                 }
 168
 169                 $lang = $matches[1];
 170                 $confidence = $matches[2];
 171
 172                 $iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang);
 173         }
 174
 175         // Do not filter if language detection confidence is too low
 176         if ($minconfidence && $confidence < $minconfidence) {
 177                 return;
 178         }
 179
 180         if (!$iso2) {
 181                 return;
 182         }
 183
 184         if (!in_array($iso2, $read_languages_array)) {
 185                 $hook_data['filter_reasons'][] = DI::l10n()->t('Filtered language: %s', ucfirst($lang));
 186         }
 187 }