libraries/File.class.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * file upload functions
   5  *
   6  * @version $Id$
   7  * @package phpMyAdmin
   8  */
   9
  10 /**
  11  *
  12  * @todo replace error messages with localized string
  13  * @todo when uploading a file into a blob field, should we also consider using
  14  *       chunks like in import? UPDATE `table` SET `field` = `field` + [chunk]
  15  * @package phpMyAdmin
  16  */
  17 class PMA_File
  18 {
  19     /**
  20      * @var string the temporary file name
  21      * @access protected
  22      */
  23     var $_name = null;
  24
  25     /**
  26      * @var string the content
  27      * @access protected
  28      */
  29     var $_content = null;
  30
  31     /**
  32      * @var string the error message
  33      * @access protected
  34      */
  35     var $_error_message = '';
  36
  37     /**
  38      * @var bool whether the file is temporary or not
  39      * @access protected
  40      */
  41     var $_is_temp = false;
  42
  43     /**
  44      * @var string type of compression
  45      * @access protected
  46      */
  47     var $_compression = null;
  48
  49     /**
  50      * @var integer
  51      */
  52     var $_offset = 0;
  53
  54     /**
  55      * @var integer size of chunk to read with every step
  56      */
  57     var $_chunk_size = 32768;
  58
  59     /**
  60      * @var resource file handle
  61      */
  62     var $_handle = null;
  63
  64     /**
  65      * @var boolean whether to decompress content before returning
  66      */
  67     var $_decompress = false;
  68
  69     /**
  70      * @var string charset of file
  71      */
  72     var $_charset = null;
  73
  74     /**
  75      * @staticvar string most recent BLOB repository reference
  76     */
  77     static $_recent_bs_reference = NULL;
  78
  79     /**
  80      * constructor
  81      *
  82      * @access  public
  83      * @uses    PMA_File::setName()
  84      * @param   string  $name   file name
  85      */
  86     function __construct($name = false)
  87     {
  88         if ($name) {
  89             $this->setName($name);
  90         }
  91     }
  92
  93     /**
  94      * destructor
  95      *
  96      * @see     PMA_File::cleanUp()
  97      * @access  public
  98      * @uses    PMA_File::cleanUp()
  99      */
 100     function __destruct()
 101     {
 102         $this->cleanUp();
 103     }
 104
 105     /**
 106      * deletes file if it is temporary, usally from a moved upload file
 107      *
 108      * @access  public
 109      * @uses    PMA_File::delet()
 110      * @uses    PMA_File::isTemp()
 111      * @return  boolean success
 112      */
 113     function cleanUp()
 114     {
 115         if ($this->isTemp()) {
 116             return $this->delete();
 117         }
 118
 119         return true;
 120     }
 121
 122     /**
 123      * deletes the file
 124      *
 125      * @access  public
 126      * @uses    PMA_File::getName()
 127      * @uses    unlink()
 128      * @return  boolean success
 129      */
 130     function delete()
 131     {
 132         return unlink($this->getName());
 133     }
 134
 135     /**
 136      * checks or sets the temp flag for this file
 137      * file objects with temp flags are deleted with object destruction
 138      *
 139      * @access  public
 140      * @uses    PMA_File::$_is_temp to set and read it
 141      * @param   boolean sets the temp flag
 142      * @return  boolean PMA_File::$_is_temp
 143      */
 144     function isTemp($is_temp = null)
 145     {
 146         if (null !== $is_temp) {
 147             $this->_is_temp = (bool) $is_temp;
 148         }
 149
 150         return $this->_is_temp;
 151     }
 152
 153     /**
 154      * accessor
 155      *
 156      * @access  public
 157      * @uses    PMA_File::$_name
 158      * @param   string  $name   file name
 159      */
 160     function setName($name)
 161     {
 162         $this->_name = trim($name);
 163     }
 164
 165     /**
 166      * @access  public
 167      * @uses    PMA_File::getName()
 168      * @uses    PMA_File::isUploaded()
 169      * @uses    PMA_File::checkUploadedFile()
 170      * @uses    PMA_File::isReadable()
 171      * @uses    PMA_File::$_content
 172      * @uses    function_exists()
 173      * @uses    file_get_contents()
 174      * @uses    filesize()
 175      * @uses    fread()
 176      * @uses    fopen()
 177      * @uses    bin2hex()
 178      * @return  string  binary file content
 179      */
 180     function getContent($as_binary = true, $offset = 0, $length = null)
 181     {
 182         if (null === $this->_content) {
 183             if ($this->isUploaded() && ! $this->checkUploadedFile()) {
 184                 return false;
 185             }
 186
 187             if (! $this->isReadable()) {
 188                 return false;
 189             }
 190
 191             if (function_exists('file_get_contents')) {
 192                 $this->_content = file_get_contents($this->getName());
 193             } elseif ($size = filesize($this->getName())) {
 194                 $this->_content = fread(fopen($this->getName(), 'rb'), $size);
 195             }
 196         }
 197
 198         if (! empty($this->_content) && $as_binary) {
 199             return '0x' . bin2hex($this->_content);
 200         }
 201
 202         if (null !== $length) {
 203             return substr($this->_content, $offset, $length);
 204         } elseif ($offset > 0) {
 205             return substr($this->_content, $offset);
 206         }
 207
 208         return $this->_content;
 209     }
 210
 211     /**
 212      * @access  public
 213      * @uses    PMA_File::getName()
 214      * @uses    is_uploaded_file()
 215      */
 216     function isUploaded()
 217     {
 218         return is_uploaded_file($this->getName());
 219     }
 220
 221     /**
 222      * accessor
 223      *
 224      * @access  public
 225      * @uses    PMA_File::$name as return value
 226      * @return  string  PMA_File::$_name
 227      */
 228     function getName()
 229     {
 230         return $this->_name;
 231     }
 232
 233     /**
 234      * @todo replace error message with localized string
 235      * @access  public
 236      * @uses    PMA_File::isUploaded()
 237      * @uses    PMA_File::setName()
 238      * @uses    PMA_File::$_error_message
 239      * @param   string  name of file uploaded
 240      * @return  boolean success
 241      */
 242     function setUploadedFile($name)
 243     {
 244         $this->setName($name);
 245
 246         if (! $this->isUploaded()) {
 247             $this->setName(null);
 248             $this->_error_message = 'not an uploaded file';
 249             return false;
 250         }
 251
 252         return true;
 253     }
 254
 255     /**
 256      * @access  public
 257      * @uses    PMA_File::fetchUploadedFromTblChangeRequestMultiple()
 258      * @uses    PMA_File::setUploadedFile()
 259      * @uses    PMA_File::setRecentBLOBReference()
 260      * @uses    curl_setopt_array()
 261      * @uses    PMA_File::$_error_message
 262      * @uses    __('The uploaded file exceeds the upload_max_filesize directive in php.ini.')
 263      * @uses    __('The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.')
 264      * @uses    __('The uploaded file was only partially uploaded.')
 265      * @uses    __('Missing a temporary folder.')
 266      * @uses    __('Failed to write file to disk.')
 267      * @uses    __('File upload stopped by extension.')
 268      * @uses    __('Unknown error in file upload.')
 269      * @uses    $_FILES
 270      * @param   string  $key    a numeric key used to identify the different rows
 271      * @param   string  $primary_key
 272      * @return  boolean success
 273      */
 274     function setUploadedFromTblChangeRequest($key, $primary = null)
 275     {
 276         if (! isset($_FILES['fields_upload_' . $key])) {
 277             return false;
 278         }
 279
 280         $file = $_FILES['fields_upload_' . $key];
 281
 282         if (null !== $primary) {
 283             $file = PMA_File::fetchUploadedFromTblChangeRequestMultiple($file, $primary);
 284         }
 285
 286         // for blobstreaming
 287         $is_bs_upload = FALSE;
 288
 289         // check if this field requires a repository upload
 290         if (isset($_REQUEST['upload_blob_repo_' . $key]))
 291             $is_bs_upload = ($_REQUEST['upload_blob_repo_' . $key]['multi_edit'][0] == "on") ? TRUE : FALSE;
 292
 293         // if request is an upload to the BLOB repository
 294         if ($is_bs_upload)
 295         {
 296             // load PMA configuration
 297             $PMA_Config = $GLOBALS['PMA_Config'];
 298
 299             // if PMA configuration is loaded
 300             if (!empty($PMA_Config))
 301             {
 302                 // load BS variables from PMA configuration
 303                 $pluginsExist  = $PMA_Config->get('BLOBSTREAMING_PLUGINS_EXIST');
 304                 $curlExists = $PMA_Config->get('CURL_EXISTS');
 305                 $bs_database = $PMA_Config->get('BLOBSTREAMABLE_DATABASES');
 306                 $bs_database = $bs_database[$_REQUEST['db']];
 307
 308                 $allBSTablesExist = TRUE;
 309
 310                 // determine if plugins and curl exist
 311                 if ($pluginsExist && $curlExists)
 312                 {
 313                     foreach ($bs_database as $table_key=>$table)
 314                     {
 315                         if (!$bs_database[$table_key]['Exists'])
 316                         {
 317                             $allBSTablesExist = FALSE;
 318                             break;
 319                         }
 320                     }
 321                 }
 322                 else
 323                     $allBSTablesExist = FALSE;
 324
 325                 // if necessary BS tables exist
 326                 if ($allBSTablesExist)
 327                 {
 328                     // setup bs variables for uploading
 329                     $bs_server = $PMA_Config->get('BLOBSTREAMING_SERVER');
 330                     $bs_db = $_REQUEST['db'];
 331                     $bs_table = $_REQUEST['table'];
 332
 333                     // setup file handle and related variables
 334                     $tmp_file = fopen($file['tmp_name'], 'r');
 335                     $tmp_file_type = $file['type'];
 336                     $tmp_file_size = $file['size'];
 337
 338                     if (!$tmp_file_type)
 339                         $tmp_file_type = NULL;
 340
 341                     // if none of the required variables contain data, return with an unknown error message
 342                     if (!$bs_server || !$bs_db || !$bs_table || !$tmp_file || !$tmp_file_size)
 343                     {
 344                         $this->_error_message = __('Unknown error in file upload.');
 345                         return FALSE;
 346                     }
 347                     else
 348                         $bs_server_path = 'http://' . $bs_server . '/' . $bs_db . '/' . $bs_table;
 349
 350                     // init curl handle
 351                     $curlHnd = curl_init ($bs_server_path);
 352
 353                     // if curl handle init successful
 354                     if ($curlHnd)
 355                     {
 356                         // specify custom header
 357                         $customHeader = array(
 358                             "Accept-Language: en-us;en;q=0;5",
 359                             "Accept-Charset: ISO-8859-1;utf-8;q=0.7,*;q=0.7",
 360                             "Content-type: $tmp_file_type"
 361                         );
 362
 363                         // specify CURL options in array
 364                         $curlOptArr = array(
 365                             CURLOPT_PUT => TRUE,
 366                             CURLOPT_HEADER => TRUE,
 367                             CURLOPT_HTTPHEADER => $customHeader,
 368                             CURLOPT_INFILESIZE => $tmp_file_size,
 369                             CURLOPT_INFILE => $tmp_file,
 370                             CURLOPT_RETURNTRANSFER => TRUE
 371                         );
 372
 373                         // pass array of options to curl handle setup function
 374                         curl_setopt_array($curlHnd, $curlOptArr);
 375
 376                         // execute curl request and retrieve error message(s) (if any)
 377                         $ret = curl_exec($curlHnd);
 378                         $errRet = curl_error($curlHnd);
 379
 380                         // close curl handle
 381                         curl_close($curlHnd);
 382
 383                         // split entire string into array of lines
 384                         $retArr = explode("\r\n", $ret);
 385
 386                         // check each line as a valid string of a BLOB reference
 387                         foreach ($retArr as $value)
 388                             if (strlen($value) > strlen("~*$bs_db/~") && "~*$bs_db/~" == substr($value, 0, strlen($bs_db) + 4))
 389                             {
 390                                 // is a valid reference, so set as current and break
 391                                 PMA_File::setRecentBLOBReference($value);
 392                                 break;
 393                             }
 394
 395                         // close file handle
 396                         if ($tmp_file)
 397                             fclose($tmp_file);
 398                     }   // end if ($curlHnd)
 399                 }   // end if ($allBSTablesExist)
 400             }   // end if ($PMA_Config)
 401         }   // end if ($is_bs_upload)
 402
 403         // check for file upload errors
 404         switch ($file['error']) {
 405             // cybot_tm: we do not use the PHP constants here cause not all constants
 406             // are defined in all versions of PHP - but the correct constants names
 407             // are given as comment
 408             case 0: //UPLOAD_ERR_OK:
 409                 return $this->setUploadedFile($file['tmp_name']);
 410                 break;
 411             case 4: //UPLOAD_ERR_NO_FILE:
 412                 break;
 413             case 1: //UPLOAD_ERR_INI_SIZE:
 414                 $this->_error_message = __('The uploaded file exceeds the upload_max_filesize directive in php.ini.');
 415                 break;
 416             case 2: //UPLOAD_ERR_FORM_SIZE:
 417                 $this->_error_message = __('The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.');
 418                 break;
 419             case 3: //UPLOAD_ERR_PARTIAL:
 420                 $this->_error_message = __('The uploaded file was only partially uploaded.');
 421                 break;
 422             case 6: //UPLOAD_ERR_NO_TMP_DIR:
 423                 $this->_error_message = __('Missing a temporary folder.');
 424                 break;
 425             case 7: //UPLOAD_ERR_CANT_WRITE:
 426                 $this->_error_message = __('Failed to write file to disk.');
 427                 break;
 428             case 8: //UPLOAD_ERR_EXTENSION:
 429                 $this->_error_message = __('File upload stopped by extension.');
 430                 break;
 431             default:
 432                 $this->_error_message = __('Unknown error in file upload.');
 433         } // end switch
 434
 435         return false;
 436     }
 437
 438     /**
 439      * strips some dimension from the multi-dimensional array from $_FILES
 440      *
 441      * <code>
 442      * $file['name']['multi_edit'][$primary] = [value]
 443      * $file['type']['multi_edit'][$primary] = [value]
 444      * $file['size']['multi_edit'][$primary] = [value]
 445      * $file['tmp_name']['multi_edit'][$primary] = [value]
 446      * $file['error']['multi_edit'][$primary] = [value]
 447      *
 448      * // becomes:
 449      *
 450      * $file['name'] = [value]
 451      * $file['type'] = [value]
 452      * $file['size'] = [value]
 453      * $file['tmp_name'] = [value]
 454      * $file['error'] = [value]
 455      * </code>
 456      *
 457      * @todo re-check if requirements changes to PHP >= 4.2.0
 458      * @access  public
 459      * @static
 460      * @param   array   $file       the array
 461      * @param   string  $primary
 462      * @return  array
 463      */
 464     function fetchUploadedFromTblChangeRequestMultiple($file, $primary)
 465     {
 466         $new_file = array(
 467             'name' => $file['name']['multi_edit'][$primary],
 468             'type' => $file['type']['multi_edit'][$primary],
 469             'size' => $file['size']['multi_edit'][$primary],
 470             'tmp_name' => $file['tmp_name']['multi_edit'][$primary],
 471             'error' => $file['error']['multi_edit'][$primary],
 472         );
 473
 474         return $new_file;
 475     }
 476
 477     /**
 478      * sets the name if the file to the one selected in the tbl_change form
 479      *
 480      * @access  public
 481      * @uses    $_REQUEST
 482      * @uses    PMA_File::setLocalSelectedFile()
 483      * @uses    is_string()
 484      * @param   string  $key    a numeric key used to identify the different rows
 485      * @param   string  $primary_key
 486      * @return  boolean success
 487      */
 488     function setSelectedFromTblChangeRequest($key, $primary = null)
 489     {
 490         if (null !== $primary) {
 491             if (! empty($_REQUEST['fields_uploadlocal_' . $key]['multi_edit'][$primary])
 492              && is_string($_REQUEST['fields_uploadlocal_' . $key]['multi_edit'][$primary])) {
 493                 // ... whether with multiple rows ...
 494                 // for blobstreaming
 495                 $is_bs_upload = FALSE;
 496
 497                 // check if this field requires a repository upload
 498                 if (isset($_REQUEST['upload_blob_repo_' . $key]))
 499                     $is_bs_upload = ($_REQUEST['upload_blob_repo_' . $key]['multi_edit'][0] == "on") ? TRUE : FALSE;
 500
 501                 // is a request to upload file to BLOB repository using uploadDir mechanism
 502                 if ($is_bs_upload)
 503                 {
 504                     // load PMA configuration
 505                     $PMA_Config = $GLOBALS['PMA_Config'];
 506
 507                     // if the PMA configuration was loaded
 508                     if (!empty($PMA_Config))
 509                     {
 510                         // load BS variables from PMA configuration
 511                         $pluginsExist  = $PMA_Config->get('BLOBSTREAMING_PLUGINS_EXIST');
 512                         $curlExists = $PMA_Config->get('CURL_EXISTS');
 513                         $bs_database = $PMA_Config->get('BLOBSTREAMABLE_DATABASES');
 514                         $bs_database = $bs_database[$_REQUEST['db']];
 515
 516                         $allBSTablesExist = TRUE;
 517
 518                         // if plugins and curl exist
 519                         if ($pluginsExist && $curlExists)
 520                         {
 521                             foreach ($bs_database as $table_key=>$table)
 522                             {
 523                                 if (!$bs_database[$table_key]['Exists'])
 524                                 {
 525                                     $allBSTablesExist = FALSE;
 526                                     break;
 527                                 }
 528                             }
 529                         }
 530                         else
 531                             $allBSTablesExist = FALSE;
 532
 533                         // if necessary BS tables exist
 534                         if ($allBSTablesExist)
 535                         {
 536                             // load BS variables
 537                             $bs_server = $PMA_Config->get('BLOBSTREAMING_SERVER');
 538                             $bs_db = $_REQUEST['db'];
 539                             $bs_table = $_REQUEST['table'];
 540
 541                             // setup uploadDir mechanism and file variables
 542                             $tmp_filename = $GLOBALS['cfg']['UploadDir'] . '/' . $_REQUEST['fields_uploadlocal_' . $key]['multi_edit'][$primary];
 543                             $tmp_file = fopen($tmp_filename, 'r');
 544                             $tmp_file_size = filesize($tmp_filename);
 545
 546                             // check if fileinfo library exists
 547                             if ($PMA_Config->get('FILEINFO_EXISTS'))
 548                             {
 549                                 // attempt to init fileinfo
 550                                 $finfo = finfo_open(FILEINFO_MIME);
 551
 552                                 // fileinfo exists
 553                                 if ($finfo)
 554                                 {
 555                                     // pass in filename to fileinfo and close fileinfo handle after
 556                                     $tmp_file_type = finfo_file($finfo, $tmp_filename);
 557                                     finfo_close($finfo);
 558                                 }
 559                             }
 560                             else // no fileinfo library exists, use file command
 561                                 $tmp_file_type = exec("file -bi " . escapeshellarg($tmp_filename));
 562
 563                             if (!$tmp_file_type)
 564                                 $tmp_file_type = NULL;
 565
 566                             // necessary variables aren't loaded, return error message (unknown error)
 567                             if (!$bs_server || !$bs_db || !$bs_table || !$tmp_file || !$tmp_file_size)
 568                             {
 569                                 $this->_error_message = __('Unknown error in file upload.');
 570                                 return FALSE;
 571                             }
 572                             else
 573                                 $bs_server_path = 'http://' . $bs_server . '/' . $bs_db . '/' . $bs_table;
 574
 575                             // init curl handle
 576                             $curlHnd = curl_init ($bs_server_path);
 577
 578                             // curl handle exists
 579                             if ($curlHnd)
 580                             {
 581                                 // specify custom header
 582                                 $customHeader = array(
 583                                         "Accept-Language: en-us;en;q=0;5",
 584                                         "Accept-Charset: ISO-8859-1;utf-8;q=0.7,*;q=0.7",
 585                                         "Content-type: $tmp_file_type"
 586                                         );
 587
 588                                 // specify custom curl options
 589                                 $curlOptArr = array(
 590                                         CURLOPT_PUT => TRUE,
 591                                         CURLOPT_HEADER => TRUE,
 592                                         CURLOPT_HTTPHEADER => $customHeader,
 593                                         CURLOPT_INFILESIZE => $tmp_file_size,
 594                                         CURLOPT_INFILE => $tmp_file,
 595                                         CURLOPT_RETURNTRANSFER => TRUE
 596                                         );
 597
 598                                 // setup custom curl options (as specified in above array)
 599                                 curl_setopt_array($curlHnd, $curlOptArr);
 600
 601                                 // execute curl request and retrieve error message(s) (if any)
 602                                 $ret = curl_exec($curlHnd);
 603                                 $errRet = curl_error($curlHnd);
 604
 605                                 // close curl handle
 606                                 curl_close($curlHnd);
 607
 608                                 // split return string into lines
 609                                 $retArr = explode("\r\n", $ret);
 610
 611                                 // check subsequent lines for valid BLOB reference string
 612                                 foreach ($retArr as $value)
 613                                     if (strlen($value) > strlen("~*$bs_db/~") && "~*$bs_db/~" == substr($value, 0, strlen($bs_db) + 4))
 614                                     {
 615                                         // is a valid reference, so set as current and break
 616                                         PMA_File::setRecentBLOBReference($value);
 617                                         break;
 618                                     }
 619
 620                                 // close file handle
 621                                 if ($tmp_file)
 622                                     fclose($tmp_file);
 623                             }   // end if ($curlHnd)
 624                         }   // end if ($allBSTablesExist)
 625                     }   // end if ($PMA_Config)
 626                 }   // end if ($is_bs_upload)
 627
 628                 return $this->setLocalSelectedFile($_REQUEST['fields_uploadlocal_' . $key]['multi_edit'][$primary]);
 629             } else {
 630                 return false;
 631             }
 632         } elseif (! empty($_REQUEST['fields_uploadlocal_' . $key])
 633          && is_string($_REQUEST['fields_uploadlocal_' . $key])) {
 634             // for blobstreaming
 635             $is_bs_upload = FALSE;
 636
 637             // check if this field requires a repository upload
 638             if (isset($_REQUEST['upload_blob_repo_' . $key]))
 639                 $is_bs_upload = ($_REQUEST['upload_blob_repo_' . $key]['multi_edit'][0] == "on") ? TRUE : FALSE;
 640
 641             // is a request to upload file to BLOB repository using uploadDir mechanism
 642             if ($is_bs_upload)
 643             {
 644                 // load PMA configuration
 645                 $PMA_Config = $GLOBALS['PMA_Config'];
 646
 647                 // if the PMA configuration was loaded
 648                 if (!empty($PMA_Config))
 649                 {
 650                     // load BS variables from PMA configuration
 651                     $pluginsExist  = $PMA_Config->get('BLOBSTREAMING_PLUGINS_EXIST');
 652                     $curlExists = $PMA_Config->get('CURL_EXISTS');
 653                     $bs_database = $PMA_Config->get('BLOBSTREAMABLE_DATABASES');
 654                     $bs_database = $bs_database[$_REQUEST['db']];
 655
 656                     $allBSTablesExist = TRUE;
 657
 658                     // if plugins and curl exist
 659                     if ($pluginsExist && $curlExists)
 660                     {
 661                         foreach ($bs_database as $table_key=>$table)
 662                         {
 663                             if (!$bs_database[$table_key]['Exists'])
 664                             {
 665                                 $allBSTablesExist = FALSE;
 666                                 break;
 667                             }
 668                         }
 669                     }
 670                     else
 671                         $allBSTablesExist = FALSE;
 672
 673                     if ($allBSTablesExist)
 674                     {
 675                         // load BS variables
 676                         $bs_server = $PMA_Config->get('BLOBSTREAMING_SERVER');
 677                         $bs_db = $_REQUEST['db'];
 678                         $bs_table = $_REQUEST['table'];
 679
 680                         // setup uploadDir mechanism and file variables
 681                         $tmp_filename = $GLOBALS['cfg']['UploadDir'] . '/' . $_REQUEST['fields_uploadlocal_' . $key]['multi_edit'][$primary];
 682                         $tmp_file = fopen($tmp_filename, 'r');
 683                         $tmp_file_size = filesize($tmp_filename);
 684
 685                         // check if fileinfo library exists
 686                         if ($PMA_Config->get('FILEINFO_EXISTS'))
 687                         {
 688                             // attempt to init fileinfo
 689                             $finfo = finfo_open(FILEINFO_MIME);
 690
 691                             // if fileinfo exists
 692                             if ($finfo)
 693                             {
 694                                 // pass in filename to fileinfo and close fileinfo handle after
 695                                 $tmp_file_type = finfo_file($finfo, $tmp_filename);
 696                                 finfo_close($finfo);
 697                             }
 698                         }
 699                         else // no fileinfo library exists, use file command
 700                             $tmp_file_type = exec("file -bi " . escapeshellarg($tmp_filename));
 701
 702                         if (!$tmp_file_type)
 703                             $tmp_file_type = NULL;
 704
 705                         // necessary variables aren't loaded, return error message (unknown error)
 706                         if (!$bs_server || !$bs_db || !$bs_table || !$tmp_file || !$tmp_file_size)
 707                         {
 708                             $this->_error_message = __('Unknown error in file upload.');
 709                             return FALSE;
 710                         }
 711                         else
 712                             $bs_server_path = 'http://' . $bs_server . '/' . $bs_db . '/' . $bs_table;
 713
 714                         // init curl handle
 715                         $curlHnd = curl_init ($bs_server_path);
 716
 717                         // if curl handle exists
 718                         if ($curlHnd)
 719                         {
 720                             // specify custom header
 721                             $customHeader = array(
 722                                     "Accept-Language: en-us;en;q=0;5",
 723                                     "Accept-Charset: ISO-8859-1;utf-8;q=0.7,*;q=0.7",
 724                                     "Content-type: $tmp_file_type"
 725                                     );
 726
 727                             // specify custom curl options
 728                             $curlOptArr = array(
 729                                     CURLOPT_PUT => TRUE,
 730                                     CURLOPT_HEADER => TRUE,
 731                                     CURLOPT_HTTPHEADER => $customHeader,
 732                                     CURLOPT_INFILESIZE => $tmp_file_size,
 733                                     CURLOPT_INFILE => $tmp_file,
 734                                     CURLOPT_RETURNTRANSFER => TRUE
 735                                     );
 736
 737                             // setup custom curl options (as specified in above array)
 738                             curl_setopt_array($curlHnd, $curlOptArr);
 739
 740                             // execute curl request and retrieve error message(s) (if any)
 741                             $ret = curl_exec($curlHnd);
 742                             $errRet = curl_error($curlHnd);
 743
 744                             // close curl handle
 745                             curl_close($curlHnd);
 746
 747                             // split return string into lines
 748                             $retArr = explode("\r\n", $ret);
 749
 750                             // check subsequent lines for valid BLOB reference string
 751                             foreach ($retArr as $value)
 752                                 if (strlen($value) > strlen("~*$bs_db/~") && "~*$bs_db/~" == substr($value, 0, strlen($bs_db) + 4))
 753                                 {
 754                                     // is a valid reference, so set as current and break
 755                                     PMA_File::setRecentBLOBReference($value);
 756                                     break;
 757                                 }
 758
 759                             // close file handle
 760                             if ($tmp_file)
 761                                 fclose($tmp_file);
 762                         }   // end if ($curlHnd)
 763                     }   // end if ($allBSTablesExist)
 764                 }   // end if ($PMA_Config)
 765             }   // end if ($is_bs_upload)
 766
 767             return $this->setLocalSelectedFile($_REQUEST['fields_uploadlocal_' . $key]);
 768         }
 769
 770          return false;
 771     }
 772
 773     /**
 774      * @access  public
 775      * @uses    PMA_File->$_error_message as return value
 776      * @return  string  error message
 777      */
 778     function getError()
 779     {
 780         return $this->_error_message;
 781     }
 782
 783     /**
 784      * @access  public
 785      * @uses    PMA_File->$_error_message to check it
 786      * @return  boolean whether an error occured or not
 787      */
 788     function isError()
 789     {
 790         return ! empty($this->_error_message);
 791     }
 792
 793     /**
 794      * checks the superglobals provided if the tbl_change form is submitted
 795      * and uses the submitted/selected file
 796      *
 797      * @access  public
 798      * @uses    PMA_File::setUploadedFromTblChangeRequest()
 799      * @uses    PMA_File::setSelectedFromTblChangeRequest()
 800      * @param   string  $key    a numeric key used to identify the different rows
 801      * @param   string  $primary_key
 802      * @return  boolean success
 803      */
 804     function checkTblChangeForm($key, $primary_key)
 805     {
 806         if ($this->setUploadedFromTblChangeRequest($key, $primary_key)) {
 807             // well done ...
 808             $this->_error_message = '';
 809             return true;
 810 /*
 811         } elseif ($this->setUploadedFromTblChangeRequest($key)) {
 812             // well done ...
 813             $this->_error_message = '';
 814             return true;
 815 */
 816         } elseif ($this->setSelectedFromTblChangeRequest($key, $primary_key)) {
 817             // well done ...
 818             $this->_error_message = '';
 819             return true;
 820 /*
 821         } elseif ($this->setSelectedFromTblChangeRequest($key)) {
 822             // well done ...
 823             $this->_error_message = '';
 824             return true;
 825 */
 826         }
 827         // all failed, whether just no file uploaded/selected or an error
 828
 829         return false;
 830     }
 831
 832     /**
 833      *
 834      * @access  public
 835      * @uses    __('File could not be read')
 836      * @uses    PMA_File::setName()
 837      * @uses    PMA_securePath()
 838      * @uses    PMA_userDir()
 839      * @uses    $GLOBALS['cfg']['UploadDir']
 840      * @param   string  $name
 841      * @return  boolean success
 842      */
 843     function setLocalSelectedFile($name)
 844     {
 845         if (empty($GLOBALS['cfg']['UploadDir'])) return false;
 846
 847         $this->setName(PMA_userDir($GLOBALS['cfg']['UploadDir']) . PMA_securePath($name));
 848         if (! $this->isReadable()) {
 849             $this->_error_message = __('File could not be read');
 850             $this->setName(null);
 851             return false;
 852         }
 853
 854         return true;
 855     }
 856
 857     /**
 858      * @access  public
 859      * @uses    PMA_File::getName()
 860      * @uses    is_readable()
 861      * @uses    ob_start()
 862      * @uses    ob_end_clean()
 863      * @return  boolean whether the file is readable or not
 864      */
 865     function isReadable()
 866     {
 867         // suppress warnings from being displayed, but not from being logged
 868         // any file access outside of open_basedir will issue a warning
 869         ob_start();
 870         $is_readable = is_readable($this->getName());
 871         ob_end_clean();
 872         return $is_readable;
 873     }
 874
 875     /**
 876      * If we are on a server with open_basedir, we must move the file
 877      * before opening it. The FAQ 1.11 explains how to create the "./tmp"
 878      * directory - if needed
 879      *
 880      * @todo replace error message with localized string
 881      * @todo move check of $cfg['TempDir'] into PMA_Config?
 882      * @access  public
 883      * @uses    $cfg['TempDir']
 884      * @uses    __('Error moving the uploaded file, see [a@./Documentation.html#faq1_11@Documentation]FAQ 1.11[/a]')
 885      * @uses    PMA_File::isReadable()
 886      * @uses    PMA_File::getName()
 887      * @uses    PMA_File::setName()
 888      * @uses    PMA_File::isTemp()
 889      * @uses    PMA_File::$_error_message
 890      * @uses    is_dir()
 891      * @uses    mkdir()
 892      * @uses    chmod()
 893      * @uses    is_writable()
 894      * @uses    basename()
 895      * @uses    move_uploaded_file()
 896      * @uses    ob_start()
 897      * @uses    ob_end_clean()
 898      * @return  boolean whether uploaded fiel is fine or not
 899      */
 900     function checkUploadedFile()
 901     {
 902         if ($this->isReadable()) {
 903             return true;
 904         }
 905
 906         if (empty($GLOBALS['cfg']['TempDir']) || ! is_writable($GLOBALS['cfg']['TempDir'])) {
 907             // cannot create directory or access, point user to FAQ 1.11
 908             $this->_error_message = __('Error moving the uploaded file, see [a@./Documentation.html#faq1_11@Documentation]FAQ 1.11[/a]');
 909             return false;
 910         }
 911
 912         $new_file_to_upload = tempnam(realpath($GLOBALS['cfg']['TempDir']), basename($this->getName()));
 913
 914         // suppress warnings from being displayed, but not from being logged
 915         // any file access outside of open_basedir will issue a warning
 916         ob_start();
 917         $move_uploaded_file_result = move_uploaded_file($this->getName(), $new_file_to_upload);
 918         ob_end_clean();
 919         if (! $move_uploaded_file_result) {
 920             $this->_error_message = 'error while moving uploaded file';
 921             return false;
 922         }
 923
 924         $this->setName($new_file_to_upload);
 925         $this->isTemp(true);
 926
 927         if (! $this->isReadable()) {
 928             $this->_error_message = 'cannot read (moved) upload file';
 929             return false;
 930         }
 931
 932         return true;
 933     }
 934
 935     /**
 936      * Detects what compression filse uses
 937      *
 938      * @todo    move file read part into readChunk() or getChunk()
 939      * @todo    add support for compression plugins
 940      * @uses    __('File could not be read')
 941      * @uses    PMA_File::$_compression to set it
 942      * @uses    PMA_File::getName()
 943      * @uses    fopen()
 944      * @uses    fread()
 945      * @uses    strlen()
 946      * @uses    fclose()
 947      * @uses    chr()
 948      * @uses    substr()
 949      * @access  protected
 950      * @return  string MIME type of compression, none for none
 951      */
 952     function _detectCompression()
 953     {
 954         // suppress warnings from being displayed, but not from being logged
 955         // f.e. any file access outside of open_basedir will issue a warning
 956         ob_start();
 957         $file = fopen($this->getName(), 'rb');
 958         ob_end_clean();
 959
 960         if (! $file) {
 961             $this->_error_message = __('File could not be read');
 962             return false;
 963         }
 964
 965         /**
 966          * @todo
 967          * get registered plugins for file compression
 968
 969         foreach (PMA_getPlugins($type = 'compression') as $plugin) {
 970             if (call_user_func_array(array($plugin['classname'], 'canHandle'), array($this->getName()))) {
 971                 $this->setCompressionPlugin($plugin);
 972                 break;
 973             }
 974         }
 975          */
 976
 977         $test = fread($file, 4);
 978         $len = strlen($test);
 979         fclose($file);
 980
 981         if ($len >= 2 && $test[0] == chr(31) && $test[1] == chr(139)) {
 982             $this->_compression = 'application/gzip';
 983         } elseif ($len >= 3 && substr($test, 0, 3) == 'BZh') {
 984             $this->_compression = 'application/bzip2';
 985         } elseif ($len >= 4 && $test == "PK\003\004") {
 986             $this->_compression = 'application/zip';
 987         } else {
 988             $this->_compression = 'none';
 989         }
 990
 991         return $this->_compression;
 992     }
 993
 994     /**
 995      * whether the content should be decompressed before returned
 996      */
 997     function setDecompressContent($decompress)
 998     {
 999         $this->_decompress = (bool) $decompress;
1000     }
1001
1002     function getHandle()
1003     {
1004         if (null === $this->_handle) {
1005             $this->open();
1006         }
1007         return $this->_handle;
1008     }
1009
1010     function setHandle($handle)
1011     {
1012         $this->_handle = $handle;
1013     }
1014
1015     /**
1016      *
1017      */
1018     function open()
1019     {
1020         if (! $this->_decompress) {
1021             $this->_handle = @fopen($this->getName(), 'r');
1022         }
1023
1024         switch ($this->getCompression()) {
1025             case false:
1026                 return false;
1027             case 'application/bzip2':
1028                 if ($GLOBALS['cfg']['BZipDump'] && @function_exists('bzopen')) {
1029                     $this->_handle = @bzopen($this->getName(), 'r');
1030                 } else {
1031                     $this->_error_message = sprintf(__('You attempted to load file with unsupported compression (%s). Either support for it is not implemented or disabled by your configuration.'), $this->getCompression());
1032                     return false;
1033                 }
1034                 break;
1035             case 'application/gzip':
1036                 if ($GLOBALS['cfg']['GZipDump'] && @function_exists('gzopen')) {
1037                     $this->_handle = @gzopen($this->getName(), 'r');
1038                 } else {
1039                     $this->_error_message = sprintf(__('You attempted to load file with unsupported compression (%s). Either support for it is not implemented or disabled by your configuration.'), $this->getCompression());
1040                     return false;
1041                 }
1042                 break;
1043             case 'application/zip':
1044                 if ($GLOBALS['cfg']['ZipDump'] && @function_exists('zip_open')) {
1045                     include_once './libraries/zip_extension.lib.php';
1046                     $result = PMA_getZipContents($this->getName());
1047                     if (! empty($result['error'])) {
1048                         $this->_error_message = PMA_Message::rawError($result['error']);
1049                         return false;
1050                     } else {
1051                         $this->content_uncompressed = $result['data'];
1052                     }
1053                     unset($result);
1054                 } else {
1055                     $this->_error_message = sprintf(__('You attempted to load file with unsupported compression (%s). Either support for it is not implemented or disabled by your configuration.'), $this->getCompression());
1056                     return false;
1057                 }
1058                 break;
1059             case 'none':
1060                 $this->_handle = @fopen($this->getName(), 'r');
1061                 break;
1062             default:
1063                 $this->_error_message = sprintf(__('You attempted to load file with unsupported compression (%s). Either support for it is not implemented or disabled by your configuration.'), $this->getCompression());
1064                 return false;
1065                 break;
1066         }
1067
1068
1069     }
1070
1071     function getCharset()
1072     {
1073         return $this->_charset;
1074     }
1075
1076     function setCharset($charset)
1077     {
1078         $this->_charset = $charset;
1079     }
1080
1081     /**
1082      * @uses    PMA_File::$_compression as return value
1083      * @uses    PMA_File::detectCompression()
1084      * @return  string MIME type of compression, none for none
1085      * @access  public
1086      */
1087     function getCompression()
1088     {
1089         if (null === $this->_compression) {
1090             return $this->_detectCompression();
1091         }
1092
1093         return $this->_compression;
1094     }
1095
1096     /**
1097      * advances the file pointer in the file handle by $length bytes/chars
1098      *
1099      * @param   integer $length numbers of chars/bytes to skip
1100      * @return  boolean
1101      * @todo this function is unused
1102      */
1103     function advanceFilePointer($length)
1104     {
1105         while ($length > 0) {
1106             // Disable read progresivity, otherwise we eat all memory!
1107             $read_multiply = 1; // required?
1108             $this->getNextChunk($length);
1109             $length -= $this->getChunkSize();
1110         }
1111     }
1112
1113     /**
1114      * http://bugs.php.net/bug.php?id=29532
1115      * bzip reads a maximum of 8192 bytes on windows systems
1116      * @todo this function is unused
1117      */
1118     function getNextChunk($max_size = null)
1119     {
1120         if (null !== $max_size) {
1121             $size = min($max_size, $this->getChunkSize());
1122         } else {
1123             $size = $this->getChunkSize();
1124         }
1125
1126         // $result = $this->handler->getNextChunk($size);
1127         $result = '';
1128         switch ($this->getCompression()) {
1129             case 'application/bzip2':
1130                 $result = '';
1131                 while (strlen($result) < $size - 8192 && ! feof($this->getHandle())) {
1132                     $result .= bzread($this->getHandle(), $size);
1133                 }
1134                 break;
1135             case 'application/gzip':
1136                 $result = gzread($this->getHandle(), $size);
1137                 break;
1138             case 'application/zip':
1139                 /*
1140                  * if getNextChunk() is used some day,
1141                  * replace this code by code similar to the one
1142                  * in open()
1143                  *
1144                 include_once './libraries/unzip.lib.php';
1145                 $import_handle = new SimpleUnzip();
1146                 $import_handle->ReadFile($this->getName());
1147                 if ($import_handle->Count() == 0) {
1148                     $this->_error_message = __('No files found inside ZIP archive!');
1149                     return false;
1150                 } elseif ($import_handle->GetError(0) != 0) {
1151                     $this->_error_message = __('Error in ZIP archive:')
1152                         . ' ' . $import_handle->GetErrorMsg(0);
1153                     return false;
1154                 } else {
1155                     $result = $import_handle->GetData(0);
1156                 }
1157                  */
1158                 break;
1159             case 'none':
1160                 $result = fread($this->getHandle(), $size);
1161                 break;
1162             default:
1163                 return false;
1164         }
1165
1166         echo $size . ' - ';
1167         echo strlen($result) . ' - ';
1168         echo (@$GLOBALS['__len__'] += strlen($result)) . ' - ';
1169         echo $this->_error_message;
1170         echo '<hr />';
1171
1172         if ($GLOBALS['charset_conversion']) {
1173             $result = PMA_convert_string($this->getCharset(), $GLOBALS['charset'], $result);
1174         } else {
1175             /**
1176              * Skip possible byte order marks (I do not think we need more
1177              * charsets, but feel free to add more, you can use wikipedia for
1178              * reference: <http://en.wikipedia.org/wiki/Byte_Order_Mark>)
1179              *
1180              * @todo BOM could be used for charset autodetection
1181              */
1182             if ($this->getOffset() === 0) {
1183                 // UTF-8
1184                 if (strncmp($result, "\xEF\xBB\xBF", 3) == 0) {
1185                     $result = substr($result, 3);
1186                 // UTF-16 BE, LE
1187                 } elseif (strncmp($result, "\xFE\xFF", 2) == 0
1188                  || strncmp($result, "\xFF\xFE", 2) == 0) {
1189                     $result = substr($result, 2);
1190                 }
1191             }
1192         }
1193
1194         $this->_offset += $size;
1195         if (0 === $result) {
1196             return true;
1197         }
1198         return $result;
1199     }
1200
1201     function getOffset()
1202     {
1203         return $this->_offset;
1204     }
1205
1206     function getChunkSize()
1207     {
1208         return $this->_chunk_size;
1209     }
1210
1211     function setChunkSize($chunk_size)
1212     {
1213         $this->_chunk_size = (int) $chunk_size;
1214     }
1215
1216     function getContentLength()
1217     {
1218         return strlen($this->_content);
1219     }
1220
1221     function eof()
1222     {
1223         if ($this->getHandle()) {
1224             return feof($this->getHandle());
1225         } else {
1226             return ($this->getOffset() >= $this->getContentLength());
1227         }
1228
1229     }
1230
1231     /**
1232      * sets reference to most recent BLOB repository reference
1233      *
1234      * @access  public
1235      * @param   string - BLOB repository reference
1236     */
1237     static function setRecentBLOBReference($ref)
1238     {
1239         PMA_File::$_recent_bs_reference = $ref;
1240     }
1241
1242     /**
1243      * retrieves reference to most recent BLOB repository reference
1244      *
1245      * @access  public
1246      * @return  string - most recent BLOB repository reference
1247     */
1248     static function getRecentBLOBReference()
1249     {
1250         $ref = PMA_File::$_recent_bs_reference;
1251         PMA_File::$_recent_bs_reference = NULL;
1252
1253         return $ref;
1254     }
1255 }
1256 ?>