libraries/transformations.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Set of functions used with the relation and pdf feature
   5  *
   6  * This file also provides basic functions to use in other plugins!
   7  * These are declared in the 'GLOBAL Plugin functions' section
   8  *
   9  * Please use short and expressive names.
  10  * For now, special characters which aren't allowed in
  11  * filenames or functions should not be used.
  12  *
  13  * Please provide a comment for your function,
  14  * what it does and what parameters are available.
  15  *
  16  * @package PhpMyAdmin
  17  */
  18 if (! defined('PHPMYADMIN')) {
  19     exit;
  20 }
  21
  22 /**
  23  * Returns array of options from string with options separated by comma,
  24  * removes quotes
  25  *
  26  * <code>
  27  * PMA_Transformation_getOptions("'option ,, quoted',abd,'2,3',");
  28  * // array {
  29  * //     'option ,, quoted',
  30  * //     'abc',
  31  * //     '2,3',
  32  * //     '',
  33  * // }
  34  * </code>
  35  *
  36  * @param string $option_string comma separated options
  37  *
  38  * @return array options
  39  */
  40 function PMA_Transformation_getOptions($option_string)
  41 {
  42     $result = array();
  43
  44     if (strlen($option_string) === 0
  45         || ! $transform_options = preg_split('/,/', $option_string)
  46     ) {
  47         return $result;
  48     }
  49
  50     while (($option = array_shift($transform_options)) !== null) {
  51         $trimmed = trim($option);
  52         if (strlen($trimmed) > 1
  53             && $trimmed[0] == "'"
  54             && $trimmed[strlen($trimmed) - 1] == "'"
  55         ) {
  56             // '...'
  57             $option = mb_substr($trimmed, 1, -1);
  58         } elseif (isset($trimmed[0]) && $trimmed[0] == "'") {
  59             // '...,
  60             $trimmed = ltrim($option);
  61             while (($option = array_shift($transform_options)) !== null) {
  62                 // ...,
  63                 $trimmed .= ',' . $option;
  64                 $rtrimmed = rtrim($trimmed);
  65                 if ($rtrimmed[strlen($rtrimmed) - 1] == "'") {
  66                     // ,...'
  67                     break;
  68                 }
  69             }
  70             $option = mb_substr($rtrimmed, 1, -1);
  71         }
  72         $result[] = stripslashes($option);
  73     }
  74
  75     return $result;
  76 }
  77
  78 /**
  79  * Gets all available MIME-types
  80  *
  81  * @access  public
  82  * @staticvar   array   mimetypes
  83  * @return array    array[mimetype], array[transformation]
  84  */
  85 function PMA_getAvailableMIMEtypes()
  86 {
  87     static $stack = null;
  88
  89     if (null !== $stack) {
  90         return $stack;
  91     }
  92
  93     $stack = array();
  94     $sub_dirs = array(
  95         'input/' => 'input_',
  96         'output/' => '',
  97         '' => ''
  98     );
  99
 100     foreach ($sub_dirs as $sd => $prefix) {
 101         $handle = opendir('libraries/plugins/transformations/' . $sd);
 102
 103         if (! $handle) {
 104             $stack[$prefix . 'transformation'] = array();
 105             $stack[$prefix . 'transformation_file'] = array();
 106             continue;
 107         }
 108
 109         $filestack = array();
 110         while ($file = readdir($handle)) {
 111             // Ignore hidden files
 112             if ($file[0] == '.') {
 113                 continue;
 114             }
 115             // Ignore old plugins (.class in filename)
 116             if (strpos($file, '.class') !== false) {
 117                 continue;
 118             }
 119             $filestack[] = $file;
 120         }
 121
 122         closedir($handle);
 123         sort($filestack);
 124
 125         foreach ($filestack as $file) {
 126             if (preg_match('|^[^.].*_.*_.*\.php$|', $file)) {
 127                 // File contains transformation functions.
 128                 $parts = explode('_', str_replace('.php', '', $file));
 129                 $mimetype = $parts[0] . "/" . $parts[1];
 130                 $stack['mimetype'][$mimetype] = $mimetype;
 131
 132                 $stack[$prefix . 'transformation'][] = $mimetype . ': ' . $parts[2];
 133                 $stack[$prefix . 'transformation_file'][] = $sd . $file;
 134                 if ($sd === '') {
 135                     $stack['input_transformation'][] = $mimetype . ': ' . $parts[2];
 136                     $stack['input_transformation_file'][] = $sd . $file;
 137                 }
 138
 139             } elseif (preg_match('|^[^.].*\.php$|', $file)) {
 140                 // File is a plain mimetype, no functions.
 141                 $base = str_replace('.php', '', $file);
 142
 143                 if ($base != 'global') {
 144                     $mimetype = str_replace('_', '/', $base);
 145                     $stack['mimetype'][$mimetype] = $mimetype;
 146                     $stack['empty_mimetype'][$mimetype] = $mimetype;
 147                 }
 148             }
 149         }
 150     }
 151     return $stack;
 152 }
 153
 154 /**
 155  * Returns the class name of the transformation
 156  *
 157  * @param string $filename transformation file name
 158  *
 159  * @return string the class name of transformation
 160  */
 161 function PMA_getTransformationClassName($filename)
 162 {
 163     // get the transformation class name
 164     $class_name = explode(".php", $filename);
 165     $class_name = 'PMA\\' . str_replace('/', '\\', $class_name[0]);
 166
 167     return $class_name;
 168 }
 169
 170 /**
 171  * Returns the description of the transformation
 172  *
 173  * @param string $file transformation file
 174  *
 175  * @return String the description of the transformation
 176  */
 177 function PMA_getTransformationDescription($file)
 178 {
 179     $include_file = 'libraries/plugins/transformations/' . $file;
 180     /* @var $class_name PMA\libraries\plugins\TransformationsInterface */
 181     $class_name = PMA_getTransformationClassName($include_file);
 182     // include and instantiate the class
 183     include_once $include_file;
 184     return $class_name::getInfo();
 185 }
 186
 187 /**
 188  * Returns the name of the transformation
 189  *
 190  * @param string $file transformation file
 191  *
 192  * @return String the name of the transformation
 193  */
 194 function PMA_getTransformationName($file)
 195 {
 196     $include_file = 'libraries/plugins/transformations/' . $file;
 197     /* @var $class_name PMA\libraries\plugins\TransformationsInterface */
 198     $class_name = PMA_getTransformationClassName($include_file);
 199     // include and instantiate the class
 200     include_once $include_file;
 201     return $class_name::getName();
 202 }
 203
 204 /**
 205  * Fixups old MIME or tranformation name to new one
 206  *
 207  * - applies some hardcoded fixups
 208  * - adds spaces after _ and numbers
 209  * - capitalizes words
 210  * - removes back spaces
 211  *
 212  * @param string $value Value to fixup
 213  *
 214  * @return string
 215  */
 216 function PMA_fixupMIME($value)
 217 {
 218     $value = str_replace(
 219         array("jpeg", "png"), array("JPEG", "PNG"), $value
 220     );
 221     return str_replace(
 222         ' ',
 223         '',
 224         ucwords(
 225             preg_replace('/([0-9_]+)/', '$1 ', $value)
 226         )
 227     );
 228 }
 229
 230 /**
 231  * Gets the mimetypes for all columns of a table
 232  *
 233  * @param string  $db       the name of the db to check for
 234  * @param string  $table    the name of the table to check for
 235  * @param boolean $strict   whether to include only results having a mimetype set
 236  * @param boolean $fullName whether to use full column names as the key
 237  *
 238  * @access public
 239  *
 240  * @return array [field_name][field_key] = field_value
 241  */
 242 function PMA_getMIME($db, $table, $strict = false, $fullName = false)
 243 {
 244     $cfgRelation = PMA_getRelationsParam();
 245
 246     if (! $cfgRelation['commwork']) {
 247         return false;
 248     }
 249
 250     $com_qry = '';
 251     if ($fullName) {
 252         $com_qry .= "SELECT CONCAT("
 253             . "`db_name`, '.', `table_name`, '.', `column_name`"
 254             . ") AS column_name, ";
 255     } else {
 256         $com_qry  = "SELECT `column_name`, ";
 257     }
 258     $com_qry .= '`mimetype`,
 259                 `transformation`,
 260                 `transformation_options`,
 261                 `input_transformation`,
 262                 `input_transformation_options`
 263          FROM ' . PMA\libraries\Util::backquote($cfgRelation['db']) . '.'
 264         . PMA\libraries\Util::backquote($cfgRelation['column_info']) . '
 265          WHERE `db_name`    = \'' . $GLOBALS['dbi']->escapeString($db) . '\'
 266            AND `table_name` = \'' . $GLOBALS['dbi']->escapeString($table) . '\'
 267            AND ( `mimetype` != \'\'' . (!$strict ? '
 268               OR `transformation` != \'\'
 269               OR `transformation_options` != \'\'
 270               OR `input_transformation` != \'\'
 271               OR `input_transformation_options` != \'\'' : '') . ')';
 272     $result = $GLOBALS['dbi']->fetchResult(
 273         $com_qry, 'column_name', null, $GLOBALS['controllink']
 274     );
 275
 276     foreach ($result as $column => $values) {
 277         // replacements in mimetype and transformation
 278         $values = str_replace("jpeg", "JPEG", $values);
 279         $values = str_replace("png", "PNG", $values);
 280
 281         // convert mimetype to new format (f.e. Text_Plain, etc)
 282         $values['mimetype'] = PMA_fixupMIME($values['mimetype']);
 283
 284         // For transformation of form
 285         // output/image_jpeg__inline.inc.php
 286         // extract dir part.
 287         $dir = explode('/', $values['transformation']);
 288         $subdir = '';
 289         if (count($dir) === 2) {
 290             $subdir = $dir[0] . '/';
 291             $values['transformation'] = $dir[1];
 292         }
 293
 294         $values['transformation'] = PMA_fixupMIME($values['transformation']);
 295         $values['transformation'] = $subdir . $values['transformation'];
 296         $result[$column] = $values;
 297     }
 298
 299     return $result;
 300 } // end of the 'PMA_getMIME()' function
 301
 302 /**
 303  * Set a single mimetype to a certain value.
 304  *
 305  * @param string  $db                 the name of the db
 306  * @param string  $table              the name of the table
 307  * @param string  $key                the name of the column
 308  * @param string  $mimetype           the mimetype of the column
 309  * @param string  $transformation     the transformation of the column
 310  * @param string  $transformationOpts the transformation options of the column
 311  * @param string  $inputTransform     the input transformation of the column
 312  * @param string  $inputTransformOpts the input transformation options of the column
 313  * @param boolean $forcedelete        force delete, will erase any existing
 314  *                                    comments for this column
 315  *
 316  * @access  public
 317  *
 318  * @return boolean  true, if comment-query was made.
 319  */
 320 function PMA_setMIME($db, $table, $key, $mimetype, $transformation,
 321     $transformationOpts, $inputTransform, $inputTransformOpts, $forcedelete = false
 322 ) {
 323     $cfgRelation = PMA_getRelationsParam();
 324
 325     if (! $cfgRelation['commwork']) {
 326         return false;
 327     }
 328
 329     // lowercase mimetype & transformation
 330     $mimetype = mb_strtolower($mimetype);
 331     $transformation = mb_strtolower($transformation);
 332
 333     // Do we have any parameter to set?
 334     $has_value = (
 335         strlen($mimetype) > 0 ||
 336         strlen($transformation) > 0 ||
 337         strlen($transformationOpts) > 0 ||
 338         strlen($inputTransform) > 0 ||
 339         strlen($inputTransformOpts) > 0
 340     );
 341
 342     $test_qry = '
 343          SELECT `mimetype`,
 344                 `comment`
 345            FROM ' . PMA\libraries\Util::backquote($cfgRelation['db']) . '.'
 346         . PMA\libraries\Util::backquote($cfgRelation['column_info']) . '
 347           WHERE `db_name`     = \'' . $GLOBALS['dbi']->escapeString($db) . '\'
 348             AND `table_name`  = \'' . $GLOBALS['dbi']->escapeString($table) . '\'
 349             AND `column_name` = \'' . $GLOBALS['dbi']->escapeString($key) . '\'';
 350
 351     $test_rs   = PMA_queryAsControlUser(
 352         $test_qry, true, PMA\libraries\DatabaseInterface::QUERY_STORE
 353     );
 354
 355     if ($test_rs && $GLOBALS['dbi']->numRows($test_rs) > 0) {
 356         $row = @$GLOBALS['dbi']->fetchAssoc($test_rs);
 357         $GLOBALS['dbi']->freeResult($test_rs);
 358
 359         if (! $forcedelete && ($has_value || strlen($row['comment']) > 0)) {
 360             $upd_query = 'UPDATE '
 361                 . PMA\libraries\Util::backquote($cfgRelation['db']) . '.'
 362                 . PMA\libraries\Util::backquote($cfgRelation['column_info'])
 363                 . ' SET '
 364                 . '`mimetype` = \''
 365                 . $GLOBALS['dbi']->escapeString($mimetype) . '\', '
 366                 . '`transformation` = \''
 367                 . $GLOBALS['dbi']->escapeString($transformation) . '\', '
 368                 . '`transformation_options` = \''
 369                 . $GLOBALS['dbi']->escapeString($transformationOpts) . '\', '
 370                 . '`input_transformation` = \''
 371                 . $GLOBALS['dbi']->escapeString($inputTransform) . '\', '
 372                 . '`input_transformation_options` = \''
 373                 . $GLOBALS['dbi']->escapeString($inputTransformOpts) . '\'';
 374         } else {
 375             $upd_query = 'DELETE FROM '
 376                 . PMA\libraries\Util::backquote($cfgRelation['db'])
 377                 . '.' . PMA\libraries\Util::backquote($cfgRelation['column_info']);
 378         }
 379         $upd_query .= '
 380             WHERE `db_name`     = \'' . $GLOBALS['dbi']->escapeString($db) . '\'
 381               AND `table_name`  = \'' . $GLOBALS['dbi']->escapeString($table)
 382                 . '\'
 383               AND `column_name` = \'' . $GLOBALS['dbi']->escapeString($key)
 384                 . '\'';
 385     } elseif ($has_value) {
 386
 387         $upd_query = 'INSERT INTO '
 388             . PMA\libraries\Util::backquote($cfgRelation['db'])
 389             . '.' . PMA\libraries\Util::backquote($cfgRelation['column_info'])
 390             . ' (db_name, table_name, column_name, mimetype, '
 391             . 'transformation, transformation_options, '
 392             . 'input_transformation, input_transformation_options) '
 393             . ' VALUES('
 394             . '\'' . $GLOBALS['dbi']->escapeString($db) . '\','
 395             . '\'' . $GLOBALS['dbi']->escapeString($table) . '\','
 396             . '\'' . $GLOBALS['dbi']->escapeString($key) . '\','
 397             . '\'' . $GLOBALS['dbi']->escapeString($mimetype) . '\','
 398             . '\'' . $GLOBALS['dbi']->escapeString($transformation) . '\','
 399             . '\'' . $GLOBALS['dbi']->escapeString($transformationOpts) . '\','
 400             . '\'' . $GLOBALS['dbi']->escapeString($inputTransform) . '\','
 401             . '\'' . $GLOBALS['dbi']->escapeString($inputTransformOpts) . '\')';
 402     }
 403
 404     if (isset($upd_query)) {
 405         return PMA_queryAsControlUser($upd_query);
 406     } else {
 407         return false;
 408     }
 409 } // end of 'PMA_setMIME()' function
 410
 411
 412 /**
 413  * GLOBAL Plugin functions
 414  */
 415
 416 /**
 417  * Delete related transformation details
 418  * after deleting database. table or column
 419  *
 420  * @param string $db     Database name
 421  * @param string $table  Table name
 422  * @param string $column Column name
 423  *
 424  * @return boolean State of the query execution
 425  */
 426 function PMA_clearTransformations($db, $table = '', $column = '')
 427 {
 428     $cfgRelation = PMA_getRelationsParam();
 429
 430     if (! isset($cfgRelation['column_info'])) {
 431         return false;
 432     }
 433
 434     $delete_sql = 'DELETE FROM '
 435         . PMA\libraries\Util::backquote($cfgRelation['db']) . '.'
 436         . PMA\libraries\Util::backquote($cfgRelation['column_info'])
 437         . ' WHERE ';
 438
 439     if (($column != '') && ($table != '')) {
 440
 441         $delete_sql .= '`db_name` = \'' . $db . '\' AND '
 442             . '`table_name` = \'' . $table . '\' AND '
 443             . '`column_name` = \'' . $column . '\' ';
 444
 445     } else if ($table != '') {
 446
 447         $delete_sql .= '`db_name` = \'' . $db . '\' AND '
 448             . '`table_name` = \'' . $table . '\' ';
 449
 450     } else {
 451         $delete_sql .= '`db_name` = \'' . $db . '\' ';
 452     }
 453
 454     return $GLOBALS['dbi']->tryQuery($delete_sql);
 455
 456 }
 457