* License: MIT
*/
-require_once('library/langdet/Text/LanguageDetect.php');
+use Friendica\App;
+use Friendica\Content\Text\BBCode;
+use Friendica\Core\Hook;
+use Friendica\Core\Renderer;
+use Friendica\DI;
/* 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_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_install()
+{
+ Hook::register('prepare_body_content_filter', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body_content_filter', 10);
+ Hook::register('addon_settings', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
+ Hook::register('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, array &$data)
+{
+ if (!DI::userSession()->getLocalUserId()) {
return;
+ }
+
+ $enabled = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'langfilter', 'enable',
+ !DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'langfilter', 'disable'));
- $enable_checked = (intval(get_pconfig(local_user(),'langfilter','disable')) ? '' : ' checked="checked" ');
- $languages = get_pconfig(local_user(),'langfilter','languages');
- 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'),
- ));
-
- return;
+ $languages = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'langfilter', 'languages');
+ $minconfidence = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'langfilter', 'minconfidence', 0) * 100;
+ $minlength = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'langfilter', 'minlength', 32);
+
+ $t = Renderer::getMarkupTemplate('settings.tpl', 'addon/langfilter/');
+ $html = Renderer::replaceMacros($t, [
+ '$intro' => DI::l10n()->t('This addon tries to identify the language posts are written in. If it does not match any language specified below, posts will be hidden by collapsing them.'),
+ '$enabled' => ['langfilter_enable', DI::l10n()->t('Use the language filter'), $enabled],
+ '$languages' => ['langfilter_languages', DI::l10n()->t('Able to read'), $languages, DI::l10n()->t('List of abbreviations (ISO 639-1 codes) for languages you speak, comma separated. For example "de,it".')],
+ '$minconfidence' => ['langfilter_minconfidence', DI::l10n()->t('Minimum confidence in language detection'), $minconfidence, DI::l10n()->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', DI::l10n()->t('Minimum length of message body'), $minlength, DI::l10n()->t('Minimum number of characters in message body for filter to be used. Posts shorter than this will not be filtered. Note: Language detection is unreliable for short content (<200 characters).')],
+ ]);
+
+ $data = [
+ 'addon' => 'langfilter',
+ 'title' => DI::l10n()->t('Language Filter'),
+ 'html' => $html,
+ 'submit' => ['langfilter-settings-submit' => DI::l10n()->t('Save Settings')],
+ ];
}
+
/* 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, array &$b)
+{
+ if (!DI::userSession()->getLocalUserId()) {
return;
+ }
- 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);
+ if (!empty($_POST['langfilter-settings-submit'])) {
+ $enable = intval($_POST['langfilter_enable'] ?? 0);
+ $languages = trim($_POST['langfilter_languages'] ?? '');
+ $minconfidence = max(0, min(100, intval($_POST['langfilter_minconfidence'] ?? 0))) / 100;
+ $minlength = intval($_POST['langfilter_minlength'] ?? 32);
+ if ($minlength <= 0) {
+ $minlength = 32;
+ }
+
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'langfilter', 'enable' , $enable);
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'langfilter', 'languages' , $languages);
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'langfilter', 'minconfidence', $minconfidence);
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'langfilter', 'minlength' , $minlength);
}
}
+
/* 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_content_filter(App $a, &$hook_data)
+{
+ $logged_user = DI::userSession()->getLocalUserId();
+ if (!$logged_user) {
+ return;
+ }
+
+ // Never filter own messages
+ // TODO: find a better way to extract this
+ $logged_user_profile = DI::baseUrl()->get() . '/profile/' . $a->getLoggedInUserNickname();
+ if ($logged_user_profile == $hook_data['item']['author-link']) {
+ return;
+ }
+
+ // Don't filter if language filter is disabled
+ if (!DI::pConfig()->get($logged_user, 'langfilter', 'enable',
+ !DI::pConfig()->get($logged_user, 'langfilter', 'disable'))
+ ) {
+ return;
+ }
+
+ $naked_body = strip_tags(
+ $hook_data['item']['rendered-html']
+ ??''?: // Equivalent of !empty()
+ BBCode::convert($hook_data['item']['body'], false, BBCode::ACTIVITYPUB, true)
+ );
+
+ $naked_body = preg_replace('#\s+#', ' ', trim($naked_body));
+
+ // Don't filter if body lenght is below minimum
+ $minlen = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'langfilter', 'minlength', 32);
+ if (!$minlen) {
+ $minlen = 32;
+ }
+
+ if (strlen($naked_body) < $minlen) {
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;
+ $read_languages_string = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'langfilter', 'languages');
+ $minconfidence = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'langfilter', 'minconfidence');
- if(local_user()) {
- $langs = get_pconfig(local_user(),'langfilter','languages');
+ // Don't filter if no spoken languages are configured
+ if (!$read_languages_string) {
+ return;
}
- if($langs) {
- $arr = explode(',',$langs);
+ $read_languages_array = explode(',', $read_languages_string);
+
+ $iso639 = new Matriphe\ISO639\ISO639;
+
+ // Extract the language of the post
+ if (!empty($hook_data['item']['language'])) {
+ $languages = json_decode($hook_data['item']['language'], true);
+ if (!is_array($languages)) {
+ return;
+ }
+
+ foreach ($languages as $iso2 => $confidence) {
+ break;
+ }
+
+ if (empty($iso2)) {
+ return;
+ }
+
+ $lang = $iso639->languageByCode1($iso2);
} else {
+ $opts = $hook_data['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];
+
+ $iso2 = $iso639->code1ByLanguage($lang);
+ }
+
+ // Do not filter if language detection confidence is too low
+ if ($minconfidence && $confidence < $minconfidence) {
return;
}
- $found = false;
-
- $opts = $b['item']['postopts'];
- if ( $opts ) {
- if ( preg_match('/^lang=([^;]*)/', $opts, $matches ) )
- {
- $lang = $matches[1];
- $lng = Text_LanguageDetect_ISO639::nameToCode2($lang);
- }
- }
- if ($lng==null)
+ if (!$iso2) {
return;
- if (! in_array($lng, $arr))
- $found = true;
- if ($lng==null)
- $found = false;
-
- if($found) {
- $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>';
+ }
+
+ if (!in_array($iso2, $read_languages_array)) {
+ $hook_data['filter_reasons'][] = DI::l10n()->t('Filtered language: %s', ucfirst($lang));
}
}
-?>
projects / friendica-addons.git / blobdiff