4 * Name: Language Filter
6 * Description: Filters out postings in languages not spoken by the users
7 * Author: Tobias Diekershoff <https://f.diekershoff.de/u/tobias>
13 /* Define the hooks we want to use
14 * that is, we have settings, we need to save the settings and we want
15 * to modify the content of a posting when friendica prepares it.
18 function langfilter_install()
20 register_hook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body', 10);
21 register_hook('plugin_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
22 register_hook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
25 function langfilter_uninstall()
27 unregister_hook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body');
28 unregister_hook('plugin_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
29 unregister_hook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
33 * 1st check if somebody logged in is calling
34 * 2nd get the current settings
35 * 3rd parse a SMARTY3 template, replacing some translateable strings for the form
38 function langfilter_addon_settings(App $a, &$s)
44 $enable_checked = (intval(get_pconfig(local_user(), 'langfilter', 'disable')) ? '' : ' checked="checked" ');
45 $languages = get_pconfig(local_user(), 'langfilter', 'languages');
46 $minconfidence = get_pconfig(local_user(), 'langfilter', 'minconfidence') * 100;
47 $minlength = get_pconfig(local_user(), 'langfilter', 'minlength');
50 $languages = 'en,de,fr,it,es';
53 $t = get_markup_template("settings.tpl", "addon/langfilter/");
54 $s .= replace_macros($t, array(
55 '$title' => t("Language Filter"),
56 '$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.'),
57 '$enabled' => array('langfilter_enable', t('Use the language filter'), $enable_checked, ''),
58 '$languages' => array('langfilter_languages', t('I speak'), $languages, t('List of abbreviations (iso2 codes) for languages you speak, comma separated. For example "de,it".')),
59 '$minconfidence' => array('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.')),
60 '$minlength' => array('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.')),
61 '$submit' => t('Save Settings'),
68 * 1st check it's a logged in user calling
69 * 2nd check the langfilter form is to be saved
70 * 3rd save the settings to the DB for later usage
73 function langfilter_addon_settings_post(App $a, &$b)
79 if ($_POST['langfilter-settings-submit']) {
80 set_pconfig(local_user(), 'langfilter', 'languages', trim($_POST['langfilter_languages']));
81 $enable = ((x($_POST, 'langfilter_enable')) ? intval($_POST['langfilter_enable']) : 0);
82 $disable = 1 - $enable;
83 set_pconfig(local_user(), 'langfilter', 'disable', $disable);
84 $minconfidence = 0 + $_POST['langfilter_minconfidence'];
85 if (!$minconfidence) {
87 } else if ($minconfidence < 0) {
89 } else if ($minconfidence > 100) {
92 set_pconfig(local_user(), 'langfilter', 'minconfidence', $minconfidence / 100.0);
94 $minlength = 0 + $_POST['langfilter_minlength'];
97 } else if ($minlengt8h < 0) {
100 set_pconfig(local_user(), 'langfilter', 'minlength', $minlength);
102 info(t('Language Filter Settings saved.') . EOL);
106 /* Actually filter postings by their language
107 * 1st check if the user wants to filter postings
108 * 2nd get the user settings which languages shall be not filtered out
109 * 3rd extract the language of a posting
110 * 4th if the determined language does not fit to the spoken languages
111 * of the user, then collapse the posting, but provide a link to
115 function langfilter_prepare_body(App $a, &$b)
117 $logged_user = local_user();
122 // Never filter own messages
123 // TODO: find a better way to extract this
124 $logged_user_profile = $a->config['system']['url'] . '/profile/' . $a->user['nickname'];
125 if ($logged_user_profile == $b['item']['author-link']) {
129 // Don't filter if language filter is disabled
130 if (get_pconfig($logged_user, 'langfilter', 'disable')) {
134 // Don't filter if body lenght is below minimum
135 $minlen = get_pconfig(local_user(), 'langfilter', 'minlength');
139 if (strlen($b['item']['body']) < $minlen) {
143 $spoken_config = get_pconfig(local_user(), 'langfilter', 'languages');
144 $minconfidence = get_pconfig(local_user(), 'langfilter', 'minconfidence');
146 // Don't filter if no spoken languages are configured
149 $spoken_languages = explode(',', $spoken_config);
151 // Extract the language of the post
152 $opts = $b['item']['postopts'];
154 // no options associated to post
157 if (!preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches)) {
158 // no lang options associated to post
163 $confidence = $matches[2];
165 // Do not filter if language detection confidence is too low
166 if ($minconfidence && $confidence < $minconfidence) {
170 $iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang);
175 $spoken = in_array($iso2, $spoken_languages);
178 $rnd = random_string(8);
179 $b['html'] = '<div id="langfilter-wrap-' . $rnd . '" class="fakelink" onclick=openClose(\'langfilter-' . $rnd . '\'); >' . sprintf(t('unspoken language %s - Click to open/close'), $lang) . '</div><div id="langfilter-' . $rnd . '" style="display: none; " >' . $b['html'] . '</div>';