langfilter/langfilter.php

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