]> git.mxchange.org Git - friendica-addons.git/blobdiff - langfilter/langfilter.php
[advancedcontentfilter] Update documentation about backslashes
[friendica-addons.git] / langfilter / langfilter.php
index 9dcb3ed1eb28622876f3330921197626f9b1c0a8..f6a6ce210500757695b043e127641d11e14234ef 100644 (file)
@@ -1,5 +1,4 @@
 <?php
-
 /*
  * Name: Language Filter
  * Version: 0.1
@@ -8,8 +7,10 @@
  * License: MIT
  */
 
-require_once('library/langdet/Text/LanguageDetect.php');
 use Friendica\App;
+use Friendica\Core\Addon;
+use Friendica\Core\L10n;
+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
@@ -18,16 +19,17 @@ use Friendica\App;
 
 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');
+       Addon::registerHook('prepare_body_content_filter', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body_content_filter', 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');
+       Addon::unregisterHook('prepare_body_content_filter', 'addon/langfilter/langfilter.php', 'langfilter_prepare_body_content_filter');
+       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
@@ -42,25 +44,25 @@ function langfilter_addon_settings(App $a, &$s)
                return;
        }
 
-       $enable_checked = (intval(get_pconfig(local_user(), 'langfilter', 'disable')) ? '' : ' checked="checked" ');
-       $languages      = get_pconfig(local_user(), 'langfilter', 'languages');
-       $minconfidence  = get_pconfig(local_user(), 'langfilter', 'minconfidence') * 100;
-       $minlength      = get_pconfig(local_user(), 'langfilter', 'minlength');
+       $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 (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.')),
-               '$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'),
-       ));
+       $s .= replace_macros($t, [
+               '$title'         => L10n::t("Language Filter"),
+               '$intro'         => L10n::t('This addon tries to identify the language posts are writen in. If it does not match any language specifed below, posts will be hidden by collapsing them.'),
+               '$enabled'       => ['langfilter_enable', L10n::t('Use the language filter'), $enable_checked, ''],
+               '$languages'     => ['langfilter_languages', L10n::t('Able to read'), $languages, L10n::t('List of abbreviations (iso2 codes) for languages you speak, comma separated. For example "de,it".')],
+               '$minconfidence' => ['langfilter_minconfidence', L10n::t('Minimum confidence in language detection'), $minconfidence, 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', L10n::t('Minimum length of message body'), $minlength, 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).')],
+               '$submit'        => L10n::t('Save Settings'),
+       ]);
 
        return;
 }
@@ -78,29 +80,29 @@ function langfilter_addon_settings_post(App $a, &$b)
        }
 
        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);
                $disable = 1 - $enable;
-               set_pconfig(local_user(), 'langfilter', 'disable', $disable);
+               PConfig::set(local_user(), 'langfilter', 'disable', $disable);
                $minconfidence = 0 + $_POST['langfilter_minconfidence'];
                if (!$minconfidence) {
                        $minconfidence = 0;
-               } else if ($minconfidence < 0) {
+               } elseif ($minconfidence < 0) {
                        $minconfidence = 0;
-               } else if ($minconfidence > 100) {
+               } elseif ($minconfidence > 100) {
                        $minconfidence = 100;
                }
-               set_pconfig(local_user(), 'langfilter', 'minconfidence', $minconfidence / 100.0);
+               PConfig::set(local_user(), 'langfilter', 'minconfidence', $minconfidence / 100.0);
 
                $minlength = 0 + $_POST['langfilter_minlength'];
                if (!$minlength) {
                        $minlength = 32;
-               } else if ($minlengt8h < 0) {
+               } elseif ($minlengt8h < 0) {
                        $minlength = 32;
                }
-               set_pconfig(local_user(), 'langfilter', 'minlength', $minlength);
+               PConfig::set(local_user(), 'langfilter', 'minlength', $minlength);
 
-               info(t('Language Filter Settings saved.') . EOL);
+               info(L10n::t('Language Filter Settings saved.') . EOL);
        }
 }
 
@@ -113,7 +115,7 @@ function langfilter_addon_settings_post(App $a, &$b)
  *     expand it again.
  */
 
-function langfilter_prepare_body(App $a, &$b)
+function langfilter_prepare_body_content_filter(App $a, &$hook_data)
 {
        $logged_user = local_user();
        if (!$logged_user) {
@@ -122,39 +124,41 @@ function langfilter_prepare_body(App $a, &$b)
 
        // 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']) {
+       $logged_user_profile = $a->get_baseurl() . '/profile/' . $a->user['nickname'];
+       if ($logged_user_profile == $hook_data['item']['author-link']) {
                return;
        }
 
        // Don't filter if language filter is disabled
-       if (get_pconfig($logged_user, 'langfilter', 'disable')) {
+       if (PConfig::get($logged_user, 'langfilter', 'disable')) {
                return;
        }
 
        // 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 (strlen($b['item']['body']) < $minlen) {
+       if (strlen($hook_data['item']['body']) < $minlen) {
                return;
        }
 
-       $spoken_config = get_pconfig(local_user(), 'langfilter', 'languages');
-       $minconfidence = get_pconfig(local_user(), 'langfilter', 'minconfidence');
+       $read_languages_string = 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)
+       if (!$read_languages_string) {
                return;
-       $spoken_languages = explode(',', $spoken_config);
+       }
+       $read_languages_array = explode(',', $read_languages_string);
 
        // Extract the language of the post
-       $opts = $b['item']['postopts'];
+       $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;
@@ -173,10 +177,8 @@ function langfilter_prepare_body(App $a, &$b)
        if (!$iso2) {
                return;
        }
-       $spoken = in_array($iso2, $spoken_languages);
 
-       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'), $lang) . '</div><div id="langfilter-' . $rnd . '" style="display: none; " >' . $b['html'] . '</div>';
+       if (!in_array($iso2, $read_languages_array)) {
+               $hook_data['filter_reasons'][] = L10n::t('Filtered language: %s', ucfirst($lang));
        }
 }