class_msgPool.inc 15.26 KiB
<?php
/*
  This code is part of FusionDirectory (http://www.fusiondirectory.org/)
  Copyright (C) 2003-2010  Cajus Pollmeier
  Copyright (C) 2011-2016  FusionDirectory
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
/*!
 * \file class_msgPool.inc
 * Source code for class msgPool
define("LDAP_READ",   1);
define("LDAP_ADD",    2);
define("LDAP_MOD",    3);
define("LDAP_DEL",    4);
define("LDAP_SEARCH", 5);
define("LDAP_AUTH",   6);
/*!
 * \brief This class contains all the messages for the various actions
class msgPool
  /*!
   * \brief Display that we have no permission to delete an object
   * \param string $name Name of the object which will be deleted
  public static function permDelete ($name = "")
    if ($name == "") {
      return _("You have no permission to delete this object!");
    if (!is_array($name)) {
      return _("You have no permission to delete the object:")."<br><br><i>$name</i>";
    if (count($name) == 1) {
      return _("You have no permission to delete the object:")."<br>".msgPool::buildList($name);
    return _("You have no permission to delete these objects:")."<br>".msgPool::buildList($name);
  /*!
   * \brief Display that we have no permission to create an object
   * \param string $name Name of the object which will be created
  public static function permCreate ($name = "")
    if ($name == "") {
      return _("You have no permission to create this object!");
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
} if (!is_array($name)) { return _("You have no permission to create the object:")."<br><br><i>$name</i>"; } if (count($name) == 1) { return _("You have no permission to create the object:")."<br>".msgPool::buildList($name); } return _("You have no permission to create these objects:")."<br>".msgPool::buildList($name); } /*! * \brief Display that we have no permission to modify an object * * \param string $name Name of the object which cannot be modified (or array of objects names) * \param string $field Name of the field of the object which cannot be modified */ public static function permModify ($name = '', $field = '') { if ($name == '') { return _('You have no permission to modify this object!'); } if (!is_array($name)) { if ($field != '') { return sprintf(_('You have no permission to modify the field "%s" of object "%s"'), $field, $name); } else { return sprintf(_('You have no permission to modify the object:<br/>%s'), '<br/><i>'.$name.'</i>'); } } if (count($name) == 1) { return sprintf(_('You have no permission to modify the object:<br/>%s'), msgPool::buildList($name)); } return sprintf(_('You have no permission to modify these objects:<br/>%s'), msgPool::buildList($name)); } /*! * \brief Display that we have no permission to view an object * * \param string $name Name of the object which will be viewed */ public static function permView ($name = "") { if ($name == "") { return _("You have no permission to view this object!"); } if (!is_array($name)) { return _("You have no permission to view the object:")."<br><br><i>$name</i>"; } if (count($name) == 1) { return _("You have no permission to view the object:")."<br>".msgPool::buildList($name); } return _("You have no permission to view these objects:")."<br>".msgPool::buildList($name); } /*! * \brief Display that we have no permission to move an object * * \param string $name Name of the object which will be moved */ public static function permMove ($name = "") { if ($name == "") {
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
return _("You have no permission to move this object!"); } if (!is_array($name)) { return _("You have no permission to move the object:")."<br><br><i>$name</i>"; } if (count($name) == 1) { return _("You have no permission to move the object:")."<br>".msgPool::buildList($name); } return _("You have no permission to move these objects:")."<br>".msgPool::buildList($name); } /*! * \brief Display field contains reserved keyword * * \param string $name The field which contains reserved keyword */ public static function reserved ($name) { return sprintf(_("The field '%s' contains a reserved keyword!"), $name); } /*! * \brief Display that a command execution failed in this plugin * * \param string $type Command type * * \param string $command Command name * * \param string $plugin Name of the plugin */ public static function cmdexecfailed ($type, $command = "", $plugin = "") { if ($command == "") { if ($plugin == "") { return sprintf(_("Cannot execute '%s' command!"), $type); } else { return sprintf(_("Cannot execute '%s' command for plugin %s!"), $type, $plugin); } } else { if ($plugin == "") { return sprintf(_("Cannot execute '%s' command (%s)!"), $type, $command); } else { return sprintf(_("Cannot execute '%s' command (%s) for plugin %s!"), $type, $command, $plugin); } } } /*! * \brief Display error about too larged value * * \param string $name Name of the value * * \param string $min The largest value */ public static function toobig ($name, $min = "") { if ($min == "") { return sprintf(_("Value for '%s' is too large!"), $name); } else { return sprintf(_("'%s' must be smaller than %s!"), $name, $min); } } /*! * \brief Display error about too small value * * \param string $name Name of the value
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
* * \param string $min The smallest value */ public static function toosmall ($name, $min = "") { if ($min == "") { return sprintf(_("Value for '%s' is too small!"), $name); } else { return sprintf(_("'%s' must be %d or above!"), $name, $min); } } /*! * \brief Display a dependence between two objects * * \param string $name1 First object * * \param string $name2 Second object */ public static function depends ($name1, $name2) { return sprintf(_("'%s' depends on '%s' - please provide both values!"), $name1, $name2); } /*! * \brief Display error about existing entry in the system * * \param string $name The attribute name * \param string $dn The existing entry dn */ public static function duplicated ($name, $dn = NULL) { if ($dn == NULL) { return sprintf(_("There is already an entry with this '%s' attribute in the system!"), $name); } else { return sprintf(_("The entry '%s' already use this '%s' attribute!"), $dn, $name); } } /*! * \brief Display error about required field empty * * \param string $name Name of the field */ public static function required ($name) { return sprintf(_("The required field '%s' is empty!"), $name); } /*! * \brief Return error about invalid value * * \param string $name The field name * * \param string $data The submited data * * \param string $example Example of a right submited data */ public static function invalid (string $name, $data = '', string $example = ''): string { if (!is_string($data)) { $data = var_export($data, TRUE); } $error = sprintf(_('The field "%s" contains an invalid value.'), htmlentities($name, ENT_COMPAT, 'UTF-8')); $error .= '<br/><br/> "'.htmlentities($data, ENT_COMPAT, 'UTF-8').'"'; /* Stylize example */ if ($example !== '') { $error .= '<br/><br/><i>'.sprintf(_('Example: %s'), htmlentities($example, ENT_COMPAT, 'UTF-8')).'</i> '; }
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
return $error; } /*! * \brief Display about missing PHP extension * * \param string $name The name of the extension */ public static function missingext ($name) { return sprintf(_("Missing %s PHP extension!"), $name); } /*! * \brief Text for a cancel button */ public static function cancelButton () { return _("Cancel"); } /*! * \brief Text for a ok button */ public static function okButton () { return _("Ok"); } /*! * \brief Text for an apply button */ public static function applyButton () { return _("Apply"); } /*! * \brief Text for a save button */ public static function saveButton () { return _("Save"); } /*! * \brief Text for an add button * * \param string $what Text for the button */ public static function addButton ($what = '') { return (($what == '') ? sprintf(_('Add')) : sprintf(_('Add %s'), $what)); } /*! * \brief Text for an delete button * * \param string $what Text for the button */ public static function delButton ($what = '') { return (($what == '') ? sprintf(_('Delete')) : sprintf(_('Delete %s'), $what)); } /*! * \brief Text for an edit button * * \param string $what Text for the button
351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
*/ public static function editButton ($what = '') { return (($what == '') ? sprintf(_('Edit...')) : sprintf(_('Edit %s...'), $what)); } /*! * \brief Text for a back button */ public static function backButton () { return _('Back'); } /*! * \brief a list from an array * * \param array $data Array with the elements of the list */ public static function buildList ($data) { $objects = "<ul>"; foreach ($data as $key => $value) { if (is_numeric($key)) { $objects .= "<li>\n<i>$value</i></li>"; } else { $objects .= "<li>\n$value (<i>$key</i>)</li>"; } } $objects .= "</ul>"; return $objects; } /*! * \brief Display error about invalid extension from account * * \param string $name Name of the extension */ public static function noValidExtension ($name) { return sprintf(_("This account has no valid %s extensions!"), $name); } /*! * \brief List the features settings enabled * * \param string $name Name of the setting * * \param array $depends Contains all the settings enabled */ public static function featuresEnabled ($name, $depends = '') { if (($depends == "") || (is_array($depends) && (count($depends) == 0))) { return sprintf(_("This account has %s settings enabled. You can disable them by clicking below."), $name); } else { if (is_array($depends)) { $depends = implode(' / ', $depends); } return sprintf(_("This account has %s settings enabled. To disable them, you'll need to remove the %s settings first!"), $name, $depends); } } /*! * \brief List the features settings disabled * * \param string $name Name of the tab * * \param array $depends Tabs this tab depends upon * * \param array $conflicts Tabs this tab conflicts with
421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490
*/ public static function featuresDisabled ($name, array $depends = [], array $conflicts = []) { if (empty($depends) && empty($conflicts)) { return sprintf(_('This account has %s settings disabled. You can enable them by clicking below.'), $name); } elseif (!empty($depends)) { return sprintf(_('This account has %s settings disabled. To enable them, you\'ll need to add the %s settings first!'), $name, implode(' / ', $depends)); } else { return sprintf(_('This account has %s settings disabled. To enable them, you\'ll need to disable the %s settings first!'), $name, implode(' / ', $conflicts)); } } /*! * \brief Display Add features button * * \param string $name Name of the feature */ public static function addFeaturesButton ($name) { return sprintf(_("Add %s settings"), $name); } /*! * \brief Display Remove features button * * \param string $name Name of the feature */ public static function removeFeaturesButton ($name) { return sprintf(_("Remove %s settings"), $name); } /*! * \brief Display : Click the 'Edit' button below to change information in this dialog */ public static function clickEditToChange () { return _("Click the 'Edit' button below to change information in this dialog"); } /*! * \brief Build an array with the months */ public static function months () { return [_("January"), _("February"), _("March"), _("April"), _("May"), _("June"), _("July"), _("August"), _("September"), _("October"), _("November"), _("December")]; } /*! * \brief Build an array with the days of a week. * Start by Sunday */ public static function weekdays () { return [ _("Sunday"), _("Monday"), _("Tuesday"), _("Wednesday"), _("Thursday"), _("Friday"), _("Saturday")]; } /*! * \brief Display LDAP error * * \param string $error Error to display * * \param string $dn the DN * * \param integer $type * * \param string $plugin
491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560
*/ public static function ldaperror ($error, $dn = '', $type = 0, $plugin = '') { /* Assign headline depending on type */ $typemap = [1 => _('read operation'), _('add operation'), _('modify operation'), _('delete operation'), _('search operation'), _('authentication')]; if (isset($typemap[$type])) { $msg = sprintf(_('LDAP %s failed!'), $typemap[$type]); } else { $msg = _('LDAP operation failed!'); } /* Fill DN information */ if ($dn != '') { $msg .= '<br/><br/><i>'._('Object').':</i> '.$dn; } $msg .= '<br/><br/><i>'._('Error').':</i> '.$error; return $msg; } /*! * \brief Display error about an incorrect upload * * \param string $reason The reason of the upload failed */ public static function incorrectUpload ($reason = "") { if ($reason == "") { return _("Upload failed!"); } return sprintf(_("Upload failed: %s"), "<br><br><i>$reason</i>"); } /*! * \brief Display error about communication failure with the infrastructure service * * \param string $error The error of the communication failure */ public static function siError ($error = "") { if ($error == "") { return _("Communication failure with the infrastructure service!"); } return sprintf(_("Communication failure with the infrastructure service: %s"), "<br><br>"._("Error").": ".$error); } /*! * \brief Display checking for a support * * \param string $what Name of the support */ public static function checkingFor ($what) { return sprintf(_("Checking for %s support"), $what); } /*! * \brief Display install or activate a PHP module * * \param string $what Name of the module */ public static function installPhpModule ($what) { return sprintf(_("Install and activate the %s PHP module."), $what); }
561562563564565566567568569
/*! * \brief Display error when checking the base */ public static function check_base () { return _("The supplied base is not valid and has been reset to the previous value!"); } }