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>
10 require_once('library/langdet/Text/LanguageDetect.php');
12 /* Define the hooks we want to use
13 * that is, we have settings, we need to save the settings and we want
14 * to modify the content of a posting when friendica prepares it.
16 function langfilter_install() {
17 register_hook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body', 10);
18 register_hook('plugin_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
19 register_hook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
21 function langfilter_uninstall() {
22 unregister_hook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body');
23 unregister_hook('plugin_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
24 unregister_hook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
28 * 1st check if somebody logged in is calling
29 * 2nd get the current settings
30 * 3rd parse a SMARTY3 template, replacing some translateable strings for the form
32 function langfilter_addon_settings(&$a,&$s) {
36 $enable_checked = (intval(get_pconfig(local_user(),'langfilter','disable')) ? '' : ' checked="checked" ');
37 $languages = get_pconfig(local_user(),'langfilter','languages');
38 $minconfidence = get_pconfig(local_user(),'langfilter','minconfidence')*100;
39 $minlength = get_pconfig(local_user(),'langfilter','minlength');
41 $languages = 'en,de,fr,it,es';
43 $t = get_markup_template("settings.tpl", "addon/langfilter/" );
44 $s .= replace_macros ($t, array(
45 '$title' => t("Language Filter"),
46 '$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.'),
47 '$enabled' => array('langfilter_enable', t('Use the language filter'), $enable_checked, ''),
48 '$languages' => array('langfilter_languages', t('I speak'), $languages, t('List of abbreviations (iso2 codes) for languages you speak, comma separated. For example "de,it".') ),
49 '$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.') ),
50 '$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.') ),
51 '$submit' => t('Save Settings'),
57 * 1st check it's a logged in user calling
58 * 2nd check the langfilter form is to be saved
59 * 3rd save the settings to the DB for later usage
61 function langfilter_addon_settings_post(&$a,&$b) {
65 if($_POST['langfilter-settings-submit']) {
66 set_pconfig(local_user(),'langfilter','languages',trim($_POST['langfilter_languages']));
67 $enable = ((x($_POST,'langfilter_enable')) ? intval($_POST['langfilter_enable']) : 0);
69 set_pconfig(local_user(),'langfilter','disable', $disable);
70 $minconfidence = 0+$_POST['langfilter_minconfidence'];
71 if ( ! $minconfidence ) $minconfidence = 0;
72 else if ( $minconfidence < 0 ) $minconfidence = 0;
73 else if ( $minconfidence > 100 ) $minconfidence = 100;
74 set_pconfig(local_user(),'langfilter','minconfidence', $minconfidence/100.0);
76 $minlength = 0+$_POST['langfilter_minlength'];
77 if ( ! $minlength ) $minlength = 32;
78 else if ( $minlength < 0 ) $minlength = 32;
79 set_pconfig(local_user(),'langfilter','minlength', $minlength);
81 info( t('Language Filter Settings saved.') . EOL);
84 /* Actually filter postings by their language
85 * 1st check if the user wants to filter postings
86 * 2nd get the user settings which languages shall be not filtered out
87 * 3rd extract the language of a posting
88 * 4th if the determined language does not fit to the spoken languages
89 * of the user, then collapse the posting, but provide a link to
92 function langfilter_prepare_body(&$a,&$b) {
94 $logged_user = local_user();
95 if ( ! $logged_user ) return;
97 # Never filter own messages
98 # TODO: find a better way to extract this
99 $logged_user_profile = $a->config['system']['url'] . '/profile/' . $a->user['nickname'];
100 if ( $logged_user_profile == $b['item']['author-link'] ) return;
102 # Don't filter if language filter is disabled
103 if( get_pconfig($logged_user,'langfilter','disable') ) return;
105 # Don't filter if body lenght is below minimum
106 $minlen = get_pconfig(local_user(),'langfilter','minlength');
107 if ( ! $minlen ) $minlen = 32;
108 if ( strlen($b['item']['body']) < $minlen ) return;
110 $spoken_config = get_pconfig(local_user(),'langfilter','languages');
111 $minconfidence = get_pconfig(local_user(),'langfilter','minconfidence');
113 # Don't filter if no spoken languages are configured
114 if ( ! $spoken_config ) return;
115 $spoken_languages = explode(',', $spoken_config);
117 # Extract the language of the post
118 $opts = $b['item']['postopts'];
119 if ( ! $opts ) return; # no options associated to post
120 if ( ! preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches ) )
121 return; # no lang options associated to post
124 $confidence = $matches[2];
126 # Do not filter if language detection confidence is too low
127 if ( $minconfidence && $confidence < $minconfidence ) return;
129 $iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang);
131 if ( ! $iso2 ) return;
132 $spoken = in_array($iso2, $spoken_languages);
135 $rnd = random_string(8);
136 $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>';