setup/lib/common.inc.php

   1 <?php
   2 /**
   3  * Loads libraries/common.inc.php and preforms some additional actions
   4  *
   5  * @package    phpMyAdmin-setup
   6  * @author     Piotr Przybylski <piotrprz@gmail.com>
   7  * @license    http://www.gnu.org/licenses/gpl.html GNU GPL 2.0
   8  * @version    $Id$
   9  */
  10
  11 /**
  12  * Do not include full common.
  13  * @ignore
  14  */
  15 define('PMA_MINIMUM_COMMON', TRUE);
  16 define('PMA_SETUP', TRUE);
  17 chdir('..');
  18
  19 require_once './libraries/common.inc.php';
  20 require_once './libraries/url_generating.lib.php';
  21 require_once './setup/lib/ConfigFile.class.php';
  22
  23 // use default error handler
  24 restore_error_handler();
  25
  26 // Save current language in a cookie, required since we use PMA_MINIMUM_COMMON
  27 PMA_setCookie('pma_lang', $GLOBALS['lang']);
  28
  29 if (!isset($_SESSION['ConfigFile'])) {
  30     $_SESSION['ConfigFile'] = array();
  31 }
  32
  33 // allows for redirection even after sending some data
  34 ob_start();
  35
  36 /**
  37  * Returns value of an element in $array given by $path.
  38  * $path is a string describing position of an element in an associative array,
  39  * eg. Servers/1/host refers to $array[Servers][1][host]
  40  *
  41  * @param  string   $path
  42  * @param  array    $array
  43  * @param  mixed    $default
  44  * @return mixed    array element or $default
  45  */
  46 function array_read($path, $array, $default = null)
  47 {
  48     $keys = explode('/', $path);
  49     $value =& $array;
  50     foreach ($keys as $key) {
  51         if (!isset($value[$key])) {
  52             return $default;
  53         }
  54         $value =& $value[$key];
  55     }
  56     return $value;
  57 }
  58
  59 /**
  60  * Stores value in an array
  61  *
  62  * @param  string   $path
  63  * @param  array    &$array
  64  * @param  mixed    $value
  65  */
  66 function array_write($path, &$array, $value)
  67 {
  68     $keys = explode('/', $path);
  69     $last_key = array_pop($keys);
  70     $a =& $array;
  71     foreach ($keys as $key) {
  72         if (!isset($a[$key])) {
  73             $a[$key] = array();
  74         }
  75         $a =& $a[$key];
  76     }
  77     $a[$last_key] = $value;
  78 }
  79
  80 /**
  81  * Removes value from an array
  82  *
  83  * @param  string   $path
  84  * @param  array    &$array
  85  * @param  mixed    $value
  86  */
  87 function array_remove($path, &$array)
  88 {
  89     $keys = explode('/', $path);
  90     $keys_last = array_pop($keys);
  91     $path = array();
  92     $depth = 0;
  93
  94     $path[0] =& $array;
  95     $found = true;
  96     // go as deep as required or possible
  97     foreach ($keys as $key) {
  98         if (!isset($path[$depth][$key])) {
  99             $found = false;
 100             break;
 101         }
 102         $depth++;
 103         $path[$depth] =& $path[$depth-1][$key];
 104     }
 105     // if element found, remove it
 106     if ($found) {
 107         unset($path[$depth][$keys_last]);
 108         $depth--;
 109     }
 110
 111     // remove empty nested arrays
 112     for (; $depth >= 0; $depth--) {
 113         if (!isset($path[$depth+1]) || count($path[$depth+1]) == 0) {
 114             unset($path[$depth][$keys[$depth]]);
 115         } else {
 116             break;
 117         }
 118     }
 119 }
 120
 121 /**
 122  * Returns sanitized language string, taking into account our special codes
 123  * for formatting. Takes variable number of arguments.
 124  * Based on PMA_sanitize from sanitize.lib.php.
 125  *
 126  * @param  string  $lang_key key in $GLOBALS WITHOUT 'strSetup' prefix
 127  * @param  mixed   $args     arguments for sprintf
 128  * @return string
 129  */
 130 function PMA_lang($lang_key)
 131 {
 132     static $search, $replace;
 133
 134     // some quick cache'ing
 135     if ($search === null) {
 136         $replace_pairs = array(
 137             '<'         => '&lt;',
 138             '>'         => '&gt;',
 139             '[em]'      => '<em>',
 140             '[/em]'     => '</em>',
 141             '[strong]'  => '<strong>',
 142             '[/strong]' => '</strong>',
 143             '[code]'    => '<code>',
 144             '[/code]'   => '</code>',
 145             '[kbd]'     => '<kbd>',
 146             '[/kbd]'    => '</kbd>',
 147             '[br]'      => '<br />',
 148             '[sup]'     => '<sup>',
 149             '[/sup]'    => '</sup>');
 150         $search = array_keys($replace_pairs);
 151         $replace = array_values($replace_pairs);
 152     }
 153     if (!isset($GLOBALS["strSetup$lang_key"])) {
 154         return $lang_key;
 155     }
 156     $message = str_replace($search, $replace, $GLOBALS["strSetup$lang_key"]);
 157     // replace [a@"$1"]$2[/a] with <a href="$1">$2</a>
 158     $message = preg_replace('#\[a@("?)([^\]]+)\1\]([^\[]+)\[/a\]#e',
 159         "PMA_lang_link_replace('$2', '$3')", $message);
 160
 161     if (func_num_args() == 1) {
 162         return $message;
 163     } else {
 164         $args = func_get_args();
 165         array_shift($args);
 166         return vsprintf($message, $args);
 167     }
 168 }
 169
 170 /**
 171  * Returns translated field name
 172  *
 173  * @param string $canonical_path
 174  * @return string
 175  */
 176 function PMA_lang_name($canonical_path)
 177 {
 178     $lang_key = str_replace(
 179         array('Servers/1/', '/'),
 180         array('Servers/', '_'),
 181         $canonical_path) . '_name';
 182     return isset($GLOBALS["strSetup$lang_key"])
 183         ? $GLOBALS["strSetup$lang_key"]
 184         : $lang_key;
 185 }
 186
 187 /**
 188  * Returns translated field description
 189  *
 190  * @param string $canonical_path
 191  * @return string
 192  */
 193 function PMA_lang_desc($canonical_path)
 194 {
 195     $lang_key = str_replace(
 196         array('Servers/1/', '/'),
 197         array('Servers/', '_'),
 198         $canonical_path) . '_desc';
 199     return isset($GLOBALS["strSetup$lang_key"])
 200         ? PMA_lang($lang_key)
 201         : '';
 202 }
 203
 204 /**
 205  * Wraps link in &lt;a&gt; tags and replaces argument separator in internal links
 206  * to the one returned by PMA_get_arg_separator()
 207  *
 208  * @param string $link
 209  * @param string $text
 210  * @return string
 211  */
 212 function PMA_lang_link_replace($link, $text)
 213 {
 214     static $separator;
 215
 216     if (!isset($separator)) {
 217         $separator = PMA_get_arg_separator('html');
 218     }
 219
 220     if (!preg_match('#^http://#', $link)) {
 221         $link = str_replace('&amp;', $separator, $link);
 222     }
 223
 224     return '<a href="' . $link . '">' . $text . '</a>';
 225 }
 226 ?>