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 require_once('library/langdet/Text/LanguageDetect.php');
  11
  12 /* Define the hooks we want to use
  13  * that is, we have settings, we need to save the settings and we want
  14  * to modify the content of a posting when friendica prepares it.
  15  */
  16 function langfilter_install() {
  17         register_hook('prepare_body',         'addon/langfilter/langfilter.php', 'langfilter_prepare_body', 10);
  18         register_hook('plugin_settings',      'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
  19         register_hook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
  20 }
  21 function langfilter_uninstall() {
  22         unregister_hook('prepare_body',         'addon/langfilter/langfilter.php', 'langfilter_prepare_body');
  23         unregister_hook('plugin_settings',      'addon/langfilter/langfilter.php', 'langfilter_addon_settings');
  24         unregister_hook('plugin_settings_post', 'addon/langfilter/langfilter.php', 'langfilter_addon_settings_post');
  25 }
  26
  27 /* The settings
  28  * 1st check if somebody logged in is calling
  29  * 2nd get the current settings
  30  * 3rd parse a SMARTY3 template, replacing some translateable strings for the form
  31  */
  32 function langfilter_addon_settings(&$a,&$s) {
  33         if(! local_user())
  34                 return;
  35
  36         $enable_checked = (intval(get_pconfig(local_user(),'langfilter','disable')) ? '' : ' checked="checked" ');
  37         $languages = get_pconfig(local_user(),'langfilter','languages');
  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             '$regex' => t('Use /expression/ to provide regular expressions'),
  47             '$languages' => array('langfilter_languages', t('I speak'), $languages, t('List of abbreviations for languages you speak, comma seperated. For excample "de,it".') ),
  48             '$submit' => t('Save Settings'),
  49         ));
  50
  51         return;
  52 }
  53 /* Save the settings
  54  * 1st check it's a logged in user calling
  55  * 2nd check the langfilter form is to be saved
  56  * 3rd save the settings to the DB for later usage
  57  */
  58 function langfilter_addon_settings_post(&$a,&$b) {
  59         if(! local_user())
  60                 return;
  61
  62         if($_POST['langfilter-settings-submit']) {
  63                 set_pconfig(local_user(),'langfilter','languages',trim($_POST['langfilter_languages']));
  64                 $enable = ((x($_POST,'langfilter_enable')) ? intval($_POST['langfilter_enable']) : 0);
  65                 $disable = 1-$enable;
  66                 set_pconfig(local_user(),'langfilter','disable', $disable);
  67                 info( t('Language Filter Settings saved.') . EOL);
  68         }
  69 }
  70 /* Actually filter postings by their language
  71  * 1st check if the user wants to filter postings
  72  * 2nd get the user settings which languages shall be not filtered out
  73  * 3rd determine the language of a posting
  74  * 4th if the determined language does not fit to the spoken languages
  75  *     of the user, then collapse the posting, but provide a link to
  76  *     expand it again.
  77  */
  78 function langfilter_prepare_body(&$a,&$b) {
  79         if(get_pconfig(local_user(),'langfilter','disable'))
  80                 return;
  81
  82         if(local_user()) {
  83                 $langs = get_pconfig(local_user(),'langfilter','languages');
  84         }
  85         if($langs) {
  86                 $arr = explode(',',$langs);
  87         } else {
  88                 return;
  89         }
  90
  91         $found = false;
  92     $l = new Text_LanguageDetect;
  93     $l->_name_mode = 2;   // two letter codes
  94     $l->_threshold = 600; // make it a bit harder to be confident with a lng
  95                           // IOW make it more possible that lng is correct
  96     $lng = $l->detectSimple($b['html']);
  97     if ($lng==null)
  98                 return;
  99     if (! in_array($lng, $arr))
 100                 $found = true;
 101         if ($lng==null)
 102                 $found = false;
 103
 104         if($found) {
 105                 $rnd = random_string(8);
 106                 $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>';
 107         }
 108 }
 109 ?>