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\L10n;
  14 use Friendica\Core\PConfig;
  15 use Friendica\Core\Renderer;
  16
  17 /* Define the hooks we want to use
  18  * that is, we have settings, we need to save the settings and we want
  19  * to modify the content of a posting when friendica prepares it.
  20  */
  21
  22 function langfilter_install()
  23 {
  24         Hook::register('prepare_body_content_filter', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body_content_filter', 10);
  25         Hook::register('addon_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
  26         Hook::register('addon_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
  27 }
  28
  29 function langfilter_uninstall()
  30 {
  31         Hook::unregister('prepare_body_content_filter', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body_content_filter');
  32         Hook::unregister('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body');
  33         Hook::unregister('addon_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
  34         Hook::unregister('addon_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
  35 }
  36
  37 /* The settings
  38  * 1st check if somebody logged in is calling
  39  * 2nd get the current settings
  40  * 3rd parse a SMARTY3 template, replacing some translateable strings for the form
  41  */
  42
  43 function langfilter_addon_settings(App $a, &$s)
  44 {
  45         if (!local_user()) {
  46                 return;
  47         }
  48
  49         $enable_checked = (intval(PConfig::get(local_user(), 'langfilter', 'disable')) ? '' : ' checked="checked" ');
  50         $languages      = PConfig::get(local_user(), 'langfilter', 'languages');
  51         $minconfidence  = PConfig::get(local_user(), 'langfilter', 'minconfidence') * 100;
  52         $minlength      = PConfig::get(local_user(), 'langfilter', 'minlength');
  53
  54         $t = Renderer::getMarkupTemplate("settings.tpl", "addon/langfilter/");
  55         $s .= Renderer::replaceMacros($t, [
  56                 '$title'         => L10n::t("Language Filter"),
  57                 '$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.'),
  58                 '$enabled'       => ['langfilter_enable', L10n::t('Use the language filter'), $enable_checked, ''],
  59                 '$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".')],
  60                 '$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.')],
  61                 '$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).')],
  62                 '$submit'        => L10n::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 (!empty($_POST['langfilter-settings-submit'])) {
  81                 PConfig::set(local_user(), 'langfilter', 'languages', trim($_POST['langfilter_languages']));
  82                 $enable = (!empty($_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 ($minlength < 0) {
  99                         $minlength = 32;
 100                 }
 101                 PConfig::set(local_user(), 'langfilter', 'minlength', $minlength);
 102
 103                 info(L10n::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_content_filter(App $a, &$hook_data)
 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->getBaseURL() . '/profile/' . $a->user['nickname'];
 126         if ($logged_user_profile == $hook_data['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         $naked_body = BBCode::toPlaintext($hook_data['item']['body'], false);
 136
 137         // Don't filter if body lenght is below minimum
 138         $minlen = PConfig::get(local_user(), 'langfilter', 'minlength', 32);
 139         if (!$minlen) {
 140                 $minlen = 32;
 141         }
 142
 143         if (strlen($naked_body) < $minlen) {
 144                 return;
 145         }
 146
 147         $read_languages_string = PConfig::get(local_user(), 'langfilter', 'languages');
 148         $minconfidence = PConfig::get(local_user(), 'langfilter', 'minconfidence');
 149
 150         // Don't filter if no spoken languages are configured
 151         if (!$read_languages_string) {
 152                 return;
 153         }
 154         $read_languages_array = explode(',', $read_languages_string);
 155
 156         // Extract the language of the post
 157         if (!empty($hook_data['item']['language'])) {
 158                 $languages = json_decode($hook_data['item']['language'], true);
 159                 if (!is_array($languages)) {
 160                         return;
 161                 }
 162
 163                 foreach ($languages as $iso2 => $confidence) {
 164                         break;
 165                 }
 166
 167                 if (empty($iso2)) {
 168                         return;
 169                 }
 170
 171                 $lang = Text_LanguageDetect_ISO639::code2ToName($iso2);
 172         } else {
 173                 $opts = $hook_data['item']['postopts'];
 174                 if (!$opts) {
 175                         // no options associated to post
 176                         return;
 177                 }
 178
 179                 if (!preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches)) {
 180                         // no lang options associated to post
 181                         return;
 182                 }
 183
 184                 $lang = $matches[1];
 185                 $confidence = $matches[2];
 186
 187                 $iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang);
 188         }
 189
 190         // Do not filter if language detection confidence is too low
 191         if ($minconfidence && $confidence < $minconfidence) {
 192                 return;
 193         }
 194
 195         if (!$iso2) {
 196                 return;
 197         }
 198
 199         if (!in_array($iso2, $read_languages_array)) {
 200                 $hook_data['filter_reasons'][] = L10n::t('Filtered language: %s', ucfirst($lang));
 201         }
 202 }