<?php
+
/*
* Name: Language Filter
* Version: 0.1
* License: MIT
*/
-require_once('library/langdet/Text/LanguageDetect.php');
+use Friendica\App;
+use Friendica\Core\Addon;
+use Friendica\Core\PConfig;
/* Define the hooks we want to use
* that is, we have settings, we need to save the settings and we want
* to modify the content of a posting when friendica prepares it.
*/
-function langfilter_install() {
- register_hook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body', 10);
- register_hook('plugin_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
- register_hook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
+
+function langfilter_install()
+{
+ Addon::registerHook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body', 10);
+ Addon::registerHook('addon_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
+ Addon::registerHook('addon_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
}
-function langfilter_uninstall() {
- unregister_hook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body');
- unregister_hook('plugin_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
- unregister_hook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
+
+function langfilter_uninstall()
+{
+ Addon::unregisterHook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body');
+ Addon::unregisterHook('addon_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
+ Addon::unregisterHook('addon_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
}
/* The settings
* 2nd get the current settings
* 3rd parse a SMARTY3 template, replacing some translateable strings for the form
*/
-function langfilter_addon_settings(&$a,&$s) {
- if(! local_user())
+
+function langfilter_addon_settings(App $a, &$s)
+{
+ if (!local_user()) {
return;
+ }
- $enable_checked = (intval(get_pconfig(local_user(),'langfilter','disable')) ? '' : ' checked="checked" ');
- $languages = get_pconfig(local_user(),'langfilter','languages');
- if(! $languages)
+ $enable_checked = (intval(PConfig::get(local_user(), 'langfilter', 'disable')) ? '' : ' checked="checked" ');
+ $languages = PConfig::get(local_user(), 'langfilter', 'languages');
+ $minconfidence = PConfig::get(local_user(), 'langfilter', 'minconfidence') * 100;
+ $minlength = PConfig::get(local_user(), 'langfilter', 'minlength');
+
+ if (!$languages) {
$languages = 'en,de,fr,it,es';
+ }
- $t = get_markup_template("settings.tpl", "addon/langfilter/" );
- $s .= replace_macros ($t, array(
- '$title' => t("Language Filter"),
- '$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.'),
- '$enabled' => array('langfilter_enable', t('Use the language filter'), $enable_checked, ''),
- '$languages' => array('langfilter_languages', t('I speak'), $languages, t('List of abbreviations for languages you speak, comma seperated. For excample "de,it".') ),
- '$submit' => t('Save Settings'),
- ));
+ $t = get_markup_template("settings.tpl", "addon/langfilter/");
+ $s .= replace_macros($t, [
+ '$title' => t("Language Filter"),
+ '$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.'),
+ '$enabled' => ['langfilter_enable', t('Use the language filter'), $enable_checked, ''],
+ '$languages' => ['langfilter_languages', t('I speak'), $languages, t('List of abbreviations (iso2 codes) for languages you speak, comma separated. For example "de,it".')],
+ '$minconfidence' => ['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.')],
+ '$minlength' => ['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.')],
+ '$submit' => t('Save Settings'),
+ ]);
return;
}
+
/* Save the settings
* 1st check it's a logged in user calling
* 2nd check the langfilter form is to be saved
* 3rd save the settings to the DB for later usage
*/
-function langfilter_addon_settings_post(&$a,&$b) {
- if(! local_user())
+
+function langfilter_addon_settings_post(App $a, &$b)
+{
+ if (!local_user()) {
return;
+ }
+
+ if ($_POST['langfilter-settings-submit']) {
+ PConfig::set(local_user(), 'langfilter', 'languages', trim($_POST['langfilter_languages']));
+ $enable = ((x($_POST, 'langfilter_enable')) ? intval($_POST['langfilter_enable']) : 0);
+ $disable = 1 - $enable;
+ PConfig::set(local_user(), 'langfilter', 'disable', $disable);
+ $minconfidence = 0 + $_POST['langfilter_minconfidence'];
+ if (!$minconfidence) {
+ $minconfidence = 0;
+ } elseif ($minconfidence < 0) {
+ $minconfidence = 0;
+ } elseif ($minconfidence > 100) {
+ $minconfidence = 100;
+ }
+ PConfig::set(local_user(), 'langfilter', 'minconfidence', $minconfidence / 100.0);
- if($_POST['langfilter-settings-submit']) {
- set_pconfig(local_user(),'langfilter','languages',trim($_POST['langfilter_languages']));
- $enable = ((x($_POST,'langfilter_enable')) ? intval($_POST['langfilter_enable']) : 0);
- $disable = 1-$enable;
- set_pconfig(local_user(),'langfilter','disable', $disable);
- info( t('Language Filter Settings saved.') . EOL);
+ $minlength = 0 + $_POST['langfilter_minlength'];
+ if (!$minlength) {
+ $minlength = 32;
+ } elseif ($minlengt8h < 0) {
+ $minlength = 32;
+ }
+ PConfig::set(local_user(), 'langfilter', 'minlength', $minlength);
+
+ info(t('Language Filter Settings saved.') . EOL);
}
}
+
/* Actually filter postings by their language
* 1st check if the user wants to filter postings
* 2nd get the user settings which languages shall be not filtered out
- * 3rd determine the language of a posting
+ * 3rd extract the language of a posting
* 4th if the determined language does not fit to the spoken languages
* of the user, then collapse the posting, but provide a link to
* expand it again.
*/
-function langfilter_prepare_body(&$a,&$b) {
- if(get_pconfig(local_user(),'langfilter','disable'))
+
+function langfilter_prepare_body(App $a, &$b)
+{
+ $logged_user = local_user();
+ if (!$logged_user) {
+ return;
+ }
+
+ // Never filter own messages
+ // TODO: find a better way to extract this
+ $logged_user_profile = $a->get_baseurl() . '/profile/' . $a->user['nickname'];
+ if ($logged_user_profile == $b['item']['author-link']) {
return;
+ }
- # Never filter own messages
- # TODO: find a better way to extract this
- $logged_user_profile = $a->config['system']['url'] . '/profile/' . $a->user['nickname'];
- if ( $logged_user_profile == $b['item']['author-link'] ) return;
+ // Don't filter if language filter is disabled
+ if (PConfig::get($logged_user, 'langfilter', 'disable')) {
+ return;
+ }
- if(local_user()) {
- $langs = get_pconfig(local_user(),'langfilter','languages');
+ // Don't filter if body lenght is below minimum
+ $minlen = PConfig::get(local_user(), 'langfilter', 'minlength');
+ if (!$minlen) {
+ $minlen = 32;
}
- if($langs) {
- $arr = explode(',',$langs);
- } else {
+ if (strlen($b['item']['body']) < $minlen) {
return;
}
- $found = false;
- $l = new Text_LanguageDetect;
- $l->_name_mode = 2; // two letter codes
- $l->_threshold = 600; // make it a bit harder to be confident with a lng
- // IOW make it more possible that lng is correct
- $lng = $l->detectSimple($b['html']);
- if ($lng==null)
+ $spoken_config = PConfig::get(local_user(), 'langfilter', 'languages');
+ $minconfidence = PConfig::get(local_user(), 'langfilter', 'minconfidence');
+
+ // Don't filter if no spoken languages are configured
+ if (!$spoken_config)
return;
- if (! in_array($lng, $arr))
- $found = true;
- if ($lng==null)
- $found = false;
+ $spoken_languages = explode(',', $spoken_config);
+
+ // Extract the language of the post
+ $opts = $b['item']['postopts'];
+ if (!$opts) {
+ // no options associated to post
+ return;
+ }
+ if (!preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches)) {
+ // no lang options associated to post
+ return;
+ }
+
+ $lang = $matches[1];
+ $confidence = $matches[2];
+
+ // Do not filter if language detection confidence is too low
+ if ($minconfidence && $confidence < $minconfidence) {
+ return;
+ }
+
+ $iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang);
+
+ if (!$iso2) {
+ return;
+ }
+ $spoken = in_array($iso2, $spoken_languages);
- if($found) {
+ if (!$spoken) {
$rnd = random_string(8);
- $b['html'] = '<div id="langfilter-wrap-' . $rnd . '" class="fakelink" onclick=openClose(\'langfilter-' . $rnd . '\'); >' . sprintf( t('unspoken language %s - Click to open/close'),$lng ) . '</div><div id="langfilter-' . $rnd . '" style="display: none; " >' . $b['html'] . '</div>';
+ $b['html'] = '<div id="langfilter-wrap-' . $rnd . '" class="fakelink" onclick=openClose(\'langfilter-' . $rnd . '\'); >' . t('unspoken language %s - Click to open/close', $lang) . '</div><div id="langfilter-' . $rnd . '" style="display: none; " >' . $b['html'] . '</div>';
}
}
-?>
projects / friendica-addons.git / blobdiff