3 * Name: Language Filter
5 * Description: Filters out postings in languages not spoken by the users
6 * Author: Tobias Diekershoff <https://f.diekershoff.de/u/tobias>
11 use Friendica\Core\Addon;
12 use Friendica\Core\L10n;
13 use Friendica\Core\PConfig;
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.
20 function langfilter_install()
22 Addon::registerHook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body', 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');
27 function langfilter_uninstall()
29 Addon::unregisterHook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body');
30 Addon::unregisterHook('addon_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
31 Addon::unregisterHook('addon_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
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
40 function langfilter_addon_settings(App $a, &$s)
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');
52 $languages = 'en,de,fr,it,es';
55 $t = get_markup_template("settings.tpl", "addon/langfilter/");
56 $s .= replace_macros($t, [
57 '$title' => L10n::t("Language Filter"),
58 '$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.'),
59 '$enabled' => ['langfilter_enable', L10n::t('Use the language filter'), $enable_checked, ''],
60 '$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".')],
61 '$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.')],
62 '$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).')],
63 '$submit' => L10n::t('Save 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
75 function langfilter_addon_settings_post(App $a, &$b)
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) {
89 } elseif ($minconfidence < 0) {
91 } elseif ($minconfidence > 100) {
94 PConfig::set(local_user(), 'langfilter', 'minconfidence', $minconfidence / 100.0);
96 $minlength = 0 + $_POST['langfilter_minlength'];
99 } elseif ($minlengt8h < 0) {
102 PConfig::set(local_user(), 'langfilter', 'minlength', $minlength);
104 info(L10n::t('Language Filter Settings saved.') . EOL);
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
117 function langfilter_prepare_body(App $a, &$b)
119 $logged_user = local_user();
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']) {
131 // Don't filter if language filter is disabled
132 if (PConfig::get($logged_user, 'langfilter', 'disable')) {
136 // Don't filter if body lenght is below minimum
137 $minlen = PConfig::get(local_user(), 'langfilter', 'minlength');
141 if (strlen($b['item']['body']) < $minlen) {
145 $spoken_config = PConfig::get(local_user(), 'langfilter', 'languages');
146 $minconfidence = PConfig::get(local_user(), 'langfilter', 'minconfidence');
148 // Don't filter if no spoken languages are configured
151 $spoken_languages = explode(',', $spoken_config);
153 // Extract the language of the post
154 $opts = $b['item']['postopts'];
156 // no options associated to post
159 if (!preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches)) {
160 // no lang options associated to post
165 $confidence = $matches[2];
167 // Do not filter if language detection confidence is too low
168 if ($minconfidence && $confidence < $minconfidence) {
172 $iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang);
177 $spoken = in_array($iso2, $spoken_languages);
180 $rnd = random_string(8);
181 $b['html'] = '<div id="langfilter-wrap-' . $rnd . '" class="fakelink" onclick=openClose(\'langfilter-' . $rnd . '\'); >' . L10n::t('Hidden content in %s - Click to open/close', $lang) . '</div><div id="langfilter-' . $rnd . '" style="display: none; " >' . $b['html'] . '</div>';