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');
39 $languages = 'en,de,fr,it,es';
41 $t = get_markup_template("settings.tpl", "addon/langfilter/" );
42 $s .= replace_macros ($t, array(
43 '$title' => t("Language Filter"),
44 '$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.'),
45 '$enabled' => array('langfilter_enable', t('Use the language filter'), $enable_checked, ''),
46 '$languages' => array('langfilter_languages', t('I speak'), $languages, t('List of abbreviations (iso2 codes) for languages you speak, comma separated. For example "de,it".') ),
47 '$submit' => t('Save Settings'),
53 * 1st check it's a logged in user calling
54 * 2nd check the langfilter form is to be saved
55 * 3rd save the settings to the DB for later usage
57 function langfilter_addon_settings_post(&$a,&$b) {
61 if($_POST['langfilter-settings-submit']) {
62 set_pconfig(local_user(),'langfilter','languages',trim($_POST['langfilter_languages']));
63 $enable = ((x($_POST,'langfilter_enable')) ? intval($_POST['langfilter_enable']) : 0);
65 set_pconfig(local_user(),'langfilter','disable', $disable);
66 $confidence = ((x($_POST,'langfilter_minconfidence')) ? intval($_POST['langfilter_minconfidence']) : 0);
67 set_pconfig(local_user(),'langfilter','minconfidence', $confidence);
68 info( t('Language Filter Settings saved.') . EOL);
71 /* Actually filter postings by their language
72 * 1st check if the user wants to filter postings
73 * 2nd get the user settings which languages shall be not filtered out
74 * 3rd extract the language of a posting
75 * 4th if the determined language does not fit to the spoken languages
76 * of the user, then collapse the posting, but provide a link to
79 function langfilter_prepare_body(&$a,&$b) {
81 $logged_user = local_user();
82 if ( ! $logged_user ) return;
84 # Never filter own messages
85 # TODO: find a better way to extract this
86 $logged_user_profile = $a->config['system']['url'] . '/profile/' . $a->user['nickname'];
87 if ( $logged_user_profile == $b['item']['author-link'] ) return;
89 # Don't filter if language filter is disabled
90 if( get_pconfig($logged_user,'langfilter','disable') ) return;
92 $spoken_config = get_pconfig(local_user(),'langfilter','languages');
93 $minconfidence = get_pconfig(local_user(),'langfilter','minconfidence');
95 # Don't filter if no spoken languages are configured
96 if ( ! $spoken_config ) return;
97 $spoken_languages = explode(',', $spoken_config);
99 # Extract the language of the post
100 $opts = $b['item']['postopts'];
101 if ( ! $opts ) return; # no options associated to post
102 if ( ! preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches ) )
103 return; # no lang options associated to post
106 $confidence = $matches[2];
108 # Do not filter if language detection confidence is too low
109 if ( $minconfidence && $confidence < $minconfidence ) return;
111 $iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang);
113 if ( ! $iso2 ) return;
114 $spoken = in_array($iso2, $spoken_languages);
117 $rnd = random_string(8);
118 $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>';