lib/htmlpurifier/HTMLPurifier/Language.php

   1 <?php
   2
   3 require_once 'HTMLPurifier/LanguageFactory.php';
   4
   5 class HTMLPurifier_Language
   6 {
   7
   8     /**
   9      * ISO 639 language code of language. Prefers shortest possible version
  10      */
  11     var $code = 'en';
  12
  13     /**
  14      * Fallback language code
  15      */
  16     var $fallback = false;
  17
  18     /**
  19      * Array of localizable messages
  20      */
  21     var $messages = array();
  22
  23     /**
  24      * Array of localizable error codes
  25      */
  26     var $errorNames = array();
  27
  28     /**
  29      * True if no message file was found for this language, so English
  30      * is being used instead. Check this if you'd like to notify the
  31      * user that they've used a non-supported language.
  32      */
  33     var $error = false;
  34
  35     /**
  36      * Has the language object been loaded yet?
  37      * @private
  38      */
  39     var $_loaded = false;
  40
  41     /**
  42      * Instances of HTMLPurifier_Config and HTMLPurifier_Context
  43      */
  44     var $config, $context;
  45
  46     function HTMLPurifier_Language($config, &$context) {
  47         $this->config  = $config;
  48         $this->context =& $context;
  49     }
  50
  51     /**
  52      * Loads language object with necessary info from factory cache
  53      * @note This is a lazy loader
  54      */
  55     function load() {
  56         if ($this->_loaded) return;
  57         $factory = HTMLPurifier_LanguageFactory::instance();
  58         $factory->loadLanguage($this->code);
  59         foreach ($factory->keys as $key) {
  60             $this->$key = $factory->cache[$this->code][$key];
  61         }
  62         $this->_loaded = true;
  63     }
  64
  65     /**
  66      * Retrieves a localised message.
  67      * @param $key string identifier of message
  68      * @return string localised message
  69      */
  70     function getMessage($key) {
  71         if (!$this->_loaded) $this->load();
  72         if (!isset($this->messages[$key])) return "[$key]";
  73         return $this->messages[$key];
  74     }
  75
  76     /**
  77      * Retrieves a localised error name.
  78      * @param $int integer error number, corresponding to PHP's error
  79      *             reporting
  80      * @return string localised message
  81      */
  82     function getErrorName($int) {
  83         if (!$this->_loaded) $this->load();
  84         if (!isset($this->errorNames[$int])) return "[Error: $int]";
  85         return $this->errorNames[$int];
  86     }
  87
  88     /**
  89      * Converts an array list into a string readable representation
  90      */
  91     function listify($array) {
  92         $sep      = $this->getMessage('Item separator');
  93         $sep_last = $this->getMessage('Item separator last');
  94         $ret = '';
  95         for ($i = 0, $c = count($array); $i < $c; $i++) {
  96             if ($i == 0) {
  97             } elseif ($i + 1 < $c) {
  98                 $ret .= $sep;
  99             } else {
 100                 $ret .= $sep_last;
 101             }
 102             $ret .= $array[$i];
 103         }
 104         return $ret;
 105     }
 106
 107     /**
 108      * Formats a localised message with passed parameters
 109      * @param $key string identifier of message
 110      * @param $args Parameters to substitute in
 111      * @return string localised message
 112      * @todo Implement conditionals? Right now, some messages make
 113      *     reference to line numbers, but those aren't always available
 114      */
 115     function formatMessage($key, $args = array()) {
 116         if (!$this->_loaded) $this->load();
 117         if (!isset($this->messages[$key])) return "[$key]";
 118         $raw = $this->messages[$key];
 119         $subst = array();
 120         $generator = false;
 121         foreach ($args as $i => $value) {
 122             if (is_object($value)) {
 123                 if (is_a($value, 'HTMLPurifier_Token')) {
 124                     // factor this out some time
 125                     if (!$generator) $generator = $this->context->get('Generator');
 126                     if (isset($value->name)) $subst['$'.$i.'.Name'] = $value->name;
 127                     if (isset($value->data)) $subst['$'.$i.'.Data'] = $value->data;
 128                     $subst['$'.$i.'.Compact'] =
 129                     $subst['$'.$i.'.Serialized'] = $generator->generateFromToken($value);
 130                     // a more complex algorithm for compact representation
 131                     // could be introduced for all types of tokens. This
 132                     // may need to be factored out into a dedicated class
 133                     if (!empty($value->attr)) {
 134                         $stripped_token = $value->copy();
 135                         $stripped_token->attr = array();
 136                         $subst['$'.$i.'.Compact'] = $generator->generateFromToken($stripped_token);
 137                     }
 138                     $subst['$'.$i.'.Line'] = $value->line ? $value->line : 'unknown';
 139                 }
 140                 continue;
 141             } elseif (is_array($value)) {
 142                 $keys = array_keys($value);
 143                 if (array_keys($keys) === $keys) {
 144                     // list
 145                     $subst['$'.$i] = $this->listify($value);
 146                 } else {
 147                     // associative array
 148                     // no $i implementation yet, sorry
 149                     $subst['$'.$i.'.Keys'] = $this->listify($keys);
 150                     $subst['$'.$i.'.Values'] = $this->listify(array_values($value));
 151                 }
 152                 continue;
 153             }
 154             $subst['$' . $i] = $value;
 155         }
 156         return strtr($raw, $subst);
 157     }
 158
 159 }
 160