langfilter/langfilter.php

   1 <?php
   2 /*
   3  * Name: Language Filter
   4  * Version: 0.1
   5  * Description: Filters out postings in languages not spoken by the users
   6  * Author: Tobias Diekershoff <https://f.diekershoff.de/u/tobias>
   7  * License: MIT
   8  */
   9
  10 /* Define the hooks we want to use
  11  * that is, we have settings, we need to save the settings and we want
  12  * to modify the content of a posting when friendica prepares it.
  13  */
  14 function langfilter_install() {
  15         register_hook('prepare_body',         'addon/langfilter/langfilter.php', 'langfilter_prepare_body', 10);
  16         register_hook('plugin_settings',      'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
  17         register_hook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
  18 }
  19 function langfilter_uninstall() {
  20         unregister_hook('prepare_body',         'addon/langfilter/langfilter.php', 'langfilter_prepare_body');
  21         unregister_hook('plugin_settings',      'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
  22         unregister_hook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
  23 }
  24
  25 /* The settings
  26  * 1st check if somebody logged in is calling
  27  * 2nd get the current settings
  28  * 3rd parse a SMARTY3 template, replacing some translateable strings for the form
  29  */
  30 function langfilter_addon_settings(&$a,&$s) {
  31         if(! local_user())
  32                 return;
  33
  34         $enable_checked = (intval(get_pconfig(local_user(),'langfilter','disable')) ? '' : ' checked="checked" ');
  35         $languages = get_pconfig(local_user(),'langfilter','languages');
  36         $minconfidence = get_pconfig(local_user(),'langfilter','minconfidence')*100;
  37         $minlength = get_pconfig(local_user(),'langfilter','minlength');
  38         if(! $languages)
  39                 $languages = 'en,de,fr,it,es';
  40
  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             '$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.') ),
  48             '$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.') ),
  49             '$submit' => t('Save Settings'),
  50         ));
  51
  52         return;
  53 }
  54 /* Save the settings
  55  * 1st check it's a logged in user calling
  56  * 2nd check the langfilter form is to be saved
  57  * 3rd save the settings to the DB for later usage
  58  */
  59 function langfilter_addon_settings_post(&$a,&$b) {
  60         if(! local_user())
  61                 return;
  62
  63         if($_POST['langfilter-settings-submit']) {
  64                 set_pconfig(local_user(),'langfilter','languages',trim($_POST['langfilter_languages']));
  65                 $enable = ((x($_POST,'langfilter_enable')) ? intval($_POST['langfilter_enable']) : 0);
  66                 $disable = 1-$enable;
  67                 set_pconfig(local_user(),'langfilter','disable', $disable);
  68                 $minconfidence = 0+$_POST['langfilter_minconfidence'];
  69                 if ( ! $minconfidence ) $minconfidence = 0;
  70                 else if ( $minconfidence < 0 ) $minconfidence = 0;
  71                 else if ( $minconfidence > 100 ) $minconfidence = 100;
  72                 set_pconfig(local_user(),'langfilter','minconfidence', $minconfidence/100.0);
  73
  74                 $minlength = 0+$_POST['langfilter_minlength'];
  75                 if ( ! $minlength ) $minlength = 32;
  76                 else if ( $minlength < 0 ) $minlength = 32;
  77                 set_pconfig(local_user(),'langfilter','minlength', $minlength);
  78
  79                 info( t('Language Filter Settings saved.') . EOL);
  80         }
  81 }
  82 /* Actually filter postings by their language
  83  * 1st check if the user wants to filter postings
  84  * 2nd get the user settings which languages shall be not filtered out
  85  * 3rd extract the language of a posting
  86  * 4th if the determined language does not fit to the spoken languages
  87  *     of the user, then collapse the posting, but provide a link to
  88  *     expand it again.
  89  */
  90 function langfilter_prepare_body(&$a,&$b) {
  91
  92     $logged_user = local_user();
  93     if ( ! $logged_user ) return;
  94
  95     # Never filter own messages
  96     # TODO: find a better way to extract this
  97     $logged_user_profile = $a->config['system']['url'] . '/profile/' . $a->user['nickname'];
  98     if ( $logged_user_profile == $b['item']['author-link'] ) return;
  99
 100     # Don't filter if language filter is disabled
 101     if( get_pconfig($logged_user,'langfilter','disable') ) return;
 102
 103     # Don't filter if body lenght is below minimum
 104     $minlen = get_pconfig(local_user(),'langfilter','minlength');
 105     if ( ! $minlen ) $minlen = 32;
 106     if ( strlen($b['item']['body']) < $minlen ) return;
 107
 108     $spoken_config = get_pconfig(local_user(),'langfilter','languages');
 109     $minconfidence = get_pconfig(local_user(),'langfilter','minconfidence');
 110
 111     # Don't filter if no spoken languages are configured
 112     if ( ! $spoken_config ) return;
 113     $spoken_languages = explode(',', $spoken_config);
 114
 115     # Extract the language of the post
 116     $opts = $b['item']['postopts'];
 117     if ( ! $opts ) return; # no options associated to post
 118     if ( ! preg_match('/\blang=([^;]*);([^:]*)/', $opts, $matches ) )
 119             return; # no lang options associated to post
 120
 121     $lang = $matches[1];
 122     $confidence = $matches[2];
 123
 124     # Do not filter if language detection confidence is too low
 125     if ( $minconfidence && $confidence < $minconfidence ) return;
 126
 127     $iso2 = Text_LanguageDetect_ISO639::nameToCode2($lang);
 128
 129     if ( ! $iso2 ) return;
 130     $spoken = in_array($iso2, $spoken_languages);
 131
 132     if( ! $spoken ) {
 133         $rnd = random_string(8);
 134         $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>';
 135     }
 136 }
 137 ?>