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>
11 require_once('library/langdet/Text/LanguageDetect.php');
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.
19 function langfilter_install()
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');
26 function langfilter_uninstall()
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');
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
39 function langfilter_addon_settings(App $a, &$s)
45 $enable_checked = (intval(get_pconfig(local_user(), 'langfilter', 'disable')) ? '' : ' checked="checked" ');
46 $languages = get_pconfig(local_user(), 'langfilter', 'languages');
47 $minconfidence = get_pconfig(local_user(), 'langfilter', 'minconfidence') * 100;
48 $minlength = get_pconfig(local_user(), 'langfilter', 'minlength');
51 $languages = 'en,de,fr,it,es';
54 $t = get_markup_template("settings.tpl", "addon/langfilter/");
55 $s .= replace_macros($t, array(
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' => array('langfilter_enable', t('Use the language filter'), $enable_checked, ''),
59 '$languages' => array('langfilter_languages', t('I speak'), $languages, t('List of abbreviations (iso2 codes) for languages you speak, comma separated. For example "de,it".')),
60 '$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.')),
61 '$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.')),
62 '$submit' => t('Save 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
74 function langfilter_addon_settings_post(App $a, &$b)
80 if ($_POST['langfilter-settings-submit']) {
81 set_pconfig(local_user(), 'langfilter', 'languages', trim($_POST['langfilter_languages']));
82 $enable = ((x($_POST, 'langfilter_enable')) ? intval($_POST['langfilter_enable']) : 0);
83 $disable = 1 - $enable;
84 set_pconfig(local_user(), 'langfilter', 'disable', $disable);
85 $minconfidence = 0 + $_POST['langfilter_minconfidence'];
86 if (!$minconfidence) {
88 } else if ($minconfidence < 0) {
90 } else if ($minconfidence > 100) {
93 set_pconfig(local_user(), 'langfilter', 'minconfidence', $minconfidence / 100.0);
95 $minlength = 0 + $_POST['langfilter_minlength'];
98 } else if ($minlengt8h < 0) {
101 set_pconfig(local_user(), 'langfilter', 'minlength', $minlength);
103 info(t('Language Filter Settings saved.') . EOL);
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
116 function langfilter_prepare_body(App $a, &$b)
118 $logged_user = local_user();
123 // Never filter own messages
124 // TODO: find a better way to extract this
125 $logged_user_profile = $a->config['system']['url'] . '/profile/' . $a->user['nickname'];
126 if ($logged_user_profile == $b['item']['author-link']) {
130 // Don't filter if language filter is disabled
131 if (get_pconfig($logged_user, 'langfilter', 'disable')) {
135 // Don't filter if body lenght is below minimum
136 $minlen = get_pconfig(local_user(), 'langfilter', 'minlength');
140 if (strlen($b['item']['body']) < $minlen) {
144 $spoken_config = get_pconfig(local_user(), 'langfilter', 'languages');
145 $minconfidence = get_pconfig(local_user(), 'langfilter', 'minconfidence');
147 // Don't filter if no spoken languages are configured
150 $spoken_languages = explode(',', $spoken_config);
152 // Extract the language of the post
153 $opts = $b['item']['postopts'];
155 // no options associated to post
158 if (!preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches)) {
159 // no lang options associated to post
164 $confidence = $matches[2];
166 // Do not filter if language detection confidence is too low
167 if ($minconfidence && $confidence < $minconfidence) {
171 $iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang);
176 $spoken = in_array($iso2, $spoken_languages);
179 $rnd = random_string(8);
180 $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>';