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\Addon;
  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', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body', 10);
  23         Addon::registerHook('plugin_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
  24         Addon::registerHook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
  25 }
  26
  27 function langfilter_uninstall()
  28 {
  29         Addon::unregisterHook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body');
  30         Addon::unregisterHook('plugin_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
  31         Addon::unregisterHook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
  32 }
  33
  34 /* The settings
  35  * 1st check if somebody logged in is calling
  36  * 2nd get the current settings
  37  * 3rd parse a SMARTY3 template, replacing some translateable strings for the form
  38  */
  39
  40 function langfilter_addon_settings(App $a, &$s)
  41 {
  42         if (!local_user()) {
  43                 return;
  44         }
  45
  46         $enable_checked = (intval(PConfig::get(local_user(), 'langfilter', 'disable')) ? '' : ' checked="checked" ');
  47         $languages      = PConfig::get(local_user(), 'langfilter', 'languages');
  48         $minconfidence  = PConfig::get(local_user(), 'langfilter', 'minconfidence') * 100;
  49         $minlength      = PConfig::get(local_user(), 'langfilter', 'minlength');
  50
  51         if (!$languages) {
  52                 $languages = 'en,de,fr,it,es';
  53         }
  54
  55         $t = get_markup_template("settings.tpl", "addon/langfilter/");
  56         $s .= replace_macros($t, [
  57                 '$title'         => t("Language Filter"),
  58                 '$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.'),
  59                 '$enabled'       => ['langfilter_enable', t('Use the language filter'), $enable_checked, ''],
  60                 '$languages'     => ['langfilter_languages', t('I speak'), $languages, t('List of abbreviations (iso2 codes) for languages you speak, comma separated. For example "de,it".')],
  61                 '$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.')],
  62                 '$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.')],
  63                 '$submit'        => t('Save Settings'),
  64         ]);
  65
  66         return;
  67 }
  68
  69 /* Save the settings
  70  * 1st check it's a logged in user calling
  71  * 2nd check the langfilter form is to be saved
  72  * 3rd save the settings to the DB for later usage
  73  */
  74
  75 function langfilter_addon_settings_post(App $a, &$b)
  76 {
  77         if (!local_user()) {
  78                 return;
  79         }
  80
  81         if ($_POST['langfilter-settings-submit']) {
  82                 PConfig::set(local_user(), 'langfilter', 'languages', trim($_POST['langfilter_languages']));
  83                 $enable = ((x($_POST, 'langfilter_enable')) ? intval($_POST['langfilter_enable']) : 0);
  84                 $disable = 1 - $enable;
  85                 PConfig::set(local_user(), 'langfilter', 'disable', $disable);
  86                 $minconfidence = 0 + $_POST['langfilter_minconfidence'];
  87                 if (!$minconfidence) {
  88                         $minconfidence = 0;
  89                 } elseif ($minconfidence < 0) {
  90                         $minconfidence = 0;
  91                 } elseif ($minconfidence > 100) {
  92                         $minconfidence = 100;
  93                 }
  94                 PConfig::set(local_user(), 'langfilter', 'minconfidence', $minconfidence / 100.0);
  95
  96                 $minlength = 0 + $_POST['langfilter_minlength'];
  97                 if (!$minlength) {
  98                         $minlength = 32;
  99                 } elseif ($minlengt8h < 0) {
 100                         $minlength = 32;
 101                 }
 102                 PConfig::set(local_user(), 'langfilter', 'minlength', $minlength);
 103
 104                 info(t('Language Filter Settings saved.') . EOL);
 105         }
 106 }
 107
 108 /* Actually filter postings by their language
 109  * 1st check if the user wants to filter postings
 110  * 2nd get the user settings which languages shall be not filtered out
 111  * 3rd extract the language of a posting
 112  * 4th if the determined language does not fit to the spoken languages
 113  *     of the user, then collapse the posting, but provide a link to
 114  *     expand it again.
 115  */
 116
 117 function langfilter_prepare_body(App $a, &$b)
 118 {
 119         $logged_user = local_user();
 120         if (!$logged_user) {
 121                 return;
 122         }
 123
 124         // Never filter own messages
 125         // TODO: find a better way to extract this
 126         $logged_user_profile = $a->get_baseurl() . '/profile/' . $a->user['nickname'];
 127         if ($logged_user_profile == $b['item']['author-link']) {
 128                 return;
 129         }
 130
 131         // Don't filter if language filter is disabled
 132         if (PConfig::get($logged_user, 'langfilter', 'disable')) {
 133                 return;
 134         }
 135
 136         // Don't filter if body lenght is below minimum
 137         $minlen = PConfig::get(local_user(), 'langfilter', 'minlength');
 138         if (!$minlen) {
 139                 $minlen = 32;
 140         }
 141         if (strlen($b['item']['body']) < $minlen) {
 142                 return;
 143         }
 144
 145         $spoken_config = PConfig::get(local_user(), 'langfilter', 'languages');
 146         $minconfidence = PConfig::get(local_user(), 'langfilter', 'minconfidence');
 147
 148         // Don't filter if no spoken languages are configured
 149         if (!$spoken_config)
 150                 return;
 151         $spoken_languages = explode(',', $spoken_config);
 152
 153         // Extract the language of the post
 154         $opts = $b['item']['postopts'];
 155         if (!$opts) {
 156                 // no options associated to post
 157                 return;
 158         }
 159         if (!preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches)) {
 160                 // no lang options associated to post
 161                 return;
 162         }
 163
 164         $lang = $matches[1];
 165         $confidence = $matches[2];
 166
 167         // Do not filter if language detection confidence is too low
 168         if ($minconfidence && $confidence < $minconfidence) {
 169                 return;
 170         }
 171
 172         $iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang);
 173
 174         if (!$iso2) {
 175                 return;
 176         }
 177         $spoken = in_array($iso2, $spoken_languages);
 178
 179         if (!$spoken) {
 180                 $rnd = random_string(8);
 181                 $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>';
 182         }
 183 }