Move languagedetect to vendor #437

Merged
MrPetovan merged 3 commits from task/move-languagedetect-to-vendor into master 2017-11-05 18:17:27 +01:00

View file

@ -1,4 +1,5 @@
<?php <?php
/* /*
* Name: Language Filter * Name: Language Filter
* Version: 0.1 * Version: 0.1
@ -7,20 +8,25 @@
* License: MIT * License: MIT
*/ */
require_once('library/langdet/Text/LanguageDetect.php'); use Friendica\App;
use Friendica\Core\PConfig;
/* Define the hooks we want to use /* Define the hooks we want to use
* that is, we have settings, we need to save the settings and we want * 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. * 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); function langfilter_install()
register_hook('plugin_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings'); {
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'); register_hook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
} }
function langfilter_uninstall() {
unregister_hook('prepare_body', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body'); function langfilter_uninstall()
unregister_hook('plugin_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings'); {
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'); unregister_hook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
} }
@ -29,58 +35,75 @@ function langfilter_uninstall() {
* 2nd get the current settings * 2nd get the current settings
* 3rd parse a SMARTY3 template, replacing some translateable strings for the form * 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; return;
}
$enable_checked = (intval(get_pconfig(local_user(),'langfilter','disable')) ? '' : ' checked="checked" '); $enable_checked = (intval(PConfig::get(local_user(), 'langfilter', 'disable')) ? '' : ' checked="checked" ');
$languages = get_pconfig(local_user(),'langfilter','languages'); $languages = PConfig::get(local_user(), 'langfilter', 'languages');
$minconfidence = get_pconfig(local_user(),'langfilter','minconfidence')*100; $minconfidence = PConfig::get(local_user(), 'langfilter', 'minconfidence') * 100;
$minlength = get_pconfig(local_user(),'langfilter','minlength'); $minlength = PConfig::get(local_user(), 'langfilter', 'minlength');
if(! $languages)
if (!$languages) {
$languages = 'en,de,fr,it,es'; $languages = 'en,de,fr,it,es';
}
$t = get_markup_template("settings.tpl", "addon/langfilter/" ); $t = get_markup_template("settings.tpl", "addon/langfilter/");
$s .= replace_macros ($t, array( $s .= replace_macros($t, array(
'$title' => t("Language Filter"), '$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.'), '$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, ''), '$enabled' => array('langfilter_enable', t('Use the language filter'), $enable_checked, ''),
'$languages' => array('langfilter_languages', t('I speak'), $languages, t('List of abbreviations (iso2 codes) for languages you speak, comma separated. For example "de,it".') ), '$languages' => array('langfilter_languages', t('I speak'), $languages, t('List of abbreviations (iso2 codes) for languages you speak, comma separated. For example "de,it".')),
'$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.') ), '$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.')),
'$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.') ), '$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.')),
'$submit' => t('Save Settings'), '$submit' => t('Save Settings'),
)); ));
return; return;
} }
/* Save the settings /* Save the settings
* 1st check it's a logged in user calling * 1st check it's a logged in user calling
* 2nd check the langfilter form is to be saved * 2nd check the langfilter form is to be saved
* 3rd save the settings to the DB for later usage * 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; return;
}
if($_POST['langfilter-settings-submit']) { if ($_POST['langfilter-settings-submit']) {
set_pconfig(local_user(),'langfilter','languages',trim($_POST['langfilter_languages'])); PConfig::set(local_user(), 'langfilter', 'languages', trim($_POST['langfilter_languages']));
$enable = ((x($_POST,'langfilter_enable')) ? intval($_POST['langfilter_enable']) : 0); $enable = ((x($_POST, 'langfilter_enable')) ? intval($_POST['langfilter_enable']) : 0);
$disable = 1-$enable; $disable = 1 - $enable;
set_pconfig(local_user(),'langfilter','disable', $disable); PConfig::set(local_user(), 'langfilter', 'disable', $disable);
$minconfidence = 0+$_POST['langfilter_minconfidence']; $minconfidence = 0 + $_POST['langfilter_minconfidence'];
if ( ! $minconfidence ) $minconfidence = 0; if (!$minconfidence) {
else if ( $minconfidence < 0 ) $minconfidence = 0; $minconfidence = 0;
else if ( $minconfidence > 100 ) $minconfidence = 100; } elseif ($minconfidence < 0) {
set_pconfig(local_user(),'langfilter','minconfidence', $minconfidence/100.0); $minconfidence = 0;
} elseif ($minconfidence > 100) {
$minconfidence = 100;
}
PConfig::set(local_user(), 'langfilter', 'minconfidence', $minconfidence / 100.0);
$minlength = 0+$_POST['langfilter_minlength']; $minlength = 0 + $_POST['langfilter_minlength'];
if ( ! $minlength ) $minlength = 32; if (!$minlength) {
else if ( $minlength < 0 ) $minlength = 32; $minlength = 32;
set_pconfig(local_user(),'langfilter','minlength', $minlength); } elseif ($minlengt8h < 0) {
$minlength = 32;
}
PConfig::set(local_user(), 'langfilter', 'minlength', $minlength);
info( t('Language Filter Settings saved.') . EOL); info(t('Language Filter Settings saved.') . EOL);
} }
} }
/* Actually filter postings by their language /* Actually filter postings by their language
* 1st check if the user wants to filter postings * 1st check if the user wants to filter postings
* 2nd get the user settings which languages shall be not filtered out * 2nd get the user settings which languages shall be not filtered out
@ -89,51 +112,71 @@ function langfilter_addon_settings_post(&$a,&$b) {
* of the user, then collapse the posting, but provide a link to * of the user, then collapse the posting, but provide a link to
* expand it again. * expand it again.
*/ */
function langfilter_prepare_body(&$a,&$b) {
$logged_user = local_user(); function langfilter_prepare_body(App $a, &$b)
if ( ! $logged_user ) return; {
$logged_user = local_user();
if (!$logged_user) {
return;
}
# Never filter own messages // Never filter own messages
# TODO: find a better way to extract this // TODO: find a better way to extract this
$logged_user_profile = $a->config['system']['url'] . '/profile/' . $a->user['nickname']; $logged_user_profile = $a->config['system']['url'] . '/profile/' . $a->user['nickname'];
if ( $logged_user_profile == $b['item']['author-link'] ) return; if ($logged_user_profile == $b['item']['author-link']) {
return;
}
# Don't filter if language filter is disabled // Don't filter if language filter is disabled
if( get_pconfig($logged_user,'langfilter','disable') ) return; if (PConfig::get($logged_user, 'langfilter', 'disable')) {
return;
}
# Don't filter if body lenght is below minimum // Don't filter if body lenght is below minimum
$minlen = get_pconfig(local_user(),'langfilter','minlength'); $minlen = PConfig::get(local_user(), 'langfilter', 'minlength');
if ( ! $minlen ) $minlen = 32; if (!$minlen) {
if ( strlen($b['item']['body']) < $minlen ) return; $minlen = 32;
}
if (strlen($b['item']['body']) < $minlen) {
return;
}
$spoken_config = get_pconfig(local_user(),'langfilter','languages'); $spoken_config = PConfig::get(local_user(), 'langfilter', 'languages');
$minconfidence = get_pconfig(local_user(),'langfilter','minconfidence'); $minconfidence = PConfig::get(local_user(), 'langfilter', 'minconfidence');
# Don't filter if no spoken languages are configured // Don't filter if no spoken languages are configured
if ( ! $spoken_config ) return; if (!$spoken_config)
$spoken_languages = explode(',', $spoken_config); return;
$spoken_languages = explode(',', $spoken_config);
# Extract the language of the post // Extract the language of the post
$opts = $b['item']['postopts']; $opts = $b['item']['postopts'];
if ( ! $opts ) return; # no options associated to post if (!$opts) {
if ( ! preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches ) ) // no options associated to post
return; # no lang options associated to post return;
}
if (!preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches)) {
// no lang options associated to post
return;
}
$lang = $matches[1]; $lang = $matches[1];
$confidence = $matches[2]; $confidence = $matches[2];
# Do not filter if language detection confidence is too low // Do not filter if language detection confidence is too low
if ( $minconfidence && $confidence < $minconfidence ) return; if ($minconfidence && $confidence < $minconfidence) {
return;
}
$iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang); $iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang);
if ( ! $iso2 ) return; if (!$iso2) {
$spoken = in_array($iso2, $spoken_languages); return;
}
$spoken = in_array($iso2, $spoken_languages);
if( ! $spoken ) { if (!$spoken) {
$rnd = random_string(8); $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'),$lang ) . '</div><div id="langfilter-' . $rnd . '" style="display: none; " >' . $b['html'] . '</div>'; $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>';
} }
} }
?>