include/upload_file.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38 /*********************************************************************************
  39
  40  * Description:
  41  ********************************************************************************/
  42 require_once('include/externalAPI/ExternalAPIFactory.php');
  43
  44 /**
  45  * @api
  46  * Manage uploaded files
  47  */
  48 class UploadFile
  49 {
  50         var $field_name;
  51         var $stored_file_name;
  52         var $original_file_name;
  53         var $temp_file_location;
  54         var $use_soap = false;
  55         var $file;
  56         var $file_ext;
  57         protected static $url = "upload/";
  58
  59         /**
  60          * Upload errors
  61          * @var array
  62          */
  63         protected static $filesError = array(
  64                         UPLOAD_ERR_OK => 'UPLOAD_ERR_OK - There is no error, the file uploaded with success.',
  65                         UPLOAD_ERR_INI_SIZE => 'UPLOAD_ERR_INI_SIZE - The uploaded file exceeds the upload_max_filesize directive in php.ini.',
  66                         UPLOAD_ERR_FORM_SIZE => 'UPLOAD_ERR_FORM_SIZE - The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.',
  67                         UPLOAD_ERR_PARTIAL => 'UPLOAD_ERR_PARTIAL - The uploaded file was only partially uploaded.',
  68                         UPLOAD_ERR_NO_FILE => 'UPLOAD_ERR_NO_FILE - No file was uploaded.',
  69                         5 => 'UNKNOWN ERROR',
  70                         UPLOAD_ERR_NO_TMP_DIR => 'UPLOAD_ERR_NO_TMP_DIR - Missing a temporary folder.',
  71                         UPLOAD_ERR_CANT_WRITE => 'UPLOAD_ERR_CANT_WRITE - Failed to write file to disk.',
  72                         UPLOAD_ERR_EXTENSION => 'UPLOAD_ERR_EXTENSION - A PHP extension stopped the file upload.',
  73                         );
  74
  75         /**
  76          * Create upload file handler
  77          * @param string $field_name Form field name
  78          */
  79         function UploadFile ($field_name = '')
  80         {
  81                 // $field_name is the name of your passed file selector field in your form
  82                 // i.e., for Emails, it is "email_attachmentX" where X is 0-9
  83                 $this->field_name = $field_name;
  84         }
  85
  86         /**
  87          * Setup for SOAP upload
  88          * @param string $filename Name for the file
  89          * @param string $file
  90          */
  91         function set_for_soap($filename, $file) {
  92                 $this->stored_file_name = $filename;
  93                 $this->use_soap = true;
  94                 $this->file = $file;
  95         }
  96
  97         /**
  98          * Get URL for a document
  99          * @deprecated
 100          * @param string stored_file_name File name in filesystem
 101          * @param string bean_id note bean ID
 102          * @return string path with file name
 103          */
 104         public static function get_url($stored_file_name, $bean_id)
 105         {
 106                 if ( empty($bean_id) && empty($stored_file_name) ) {
 107             return self::$url;
 108                 }
 109
 110                 return self::$url . $bean_id;
 111         }
 112
 113         /**
 114          * Get URL of the uploaded file related to the document
 115          * @param SugarBean $document
 116          * @param string $type Type of the document, if different from $document
 117          */
 118         public static function get_upload_url($document, $type = null)
 119         {
 120             if(empty($type)) {
 121                 $type = $document->module_dir;
 122             }
 123             return "index.php?entryPoint=download&type=$type&id={$document->id}";
 124         }
 125
 126         /**
 127          * Try renaming a file to bean_id name
 128          * @param string $filename
 129          * @param string $bean_id
 130          */
 131         protected static function tryRename($filename, $bean_id)
 132         {
 133             $fullname = "upload://$bean_id.$filename";
 134             if(file_exists($fullname)) {
 135             if(!rename($fullname,  "upload://$bean_id")) {
 136                 $GLOBALS['log']->fatal("unable to rename file: $fullname => $bean_id");
 137             }
 138                 return true;
 139             }
 140             return false;
 141         }
 142
 143         /**
 144          * builds a URL path for an anchor tag
 145          * @param string stored_file_name File name in filesystem
 146          * @param string bean_id note bean ID
 147          * @return string path with file name
 148          */
 149         static public function get_file_path($stored_file_name, $bean_id, $skip_rename = false)
 150         {
 151                 global $locale;
 152
 153         // if the parameters are empty strings, just return back the upload_dir
 154                 if ( empty($bean_id) && empty($stored_file_name) ) {
 155             return "upload://";
 156                 }
 157
 158                 if(!$skip_rename) {
 159                 self::tryRename(rawurlencode($stored_file_name), $bean_id) ||
 160                 self::tryRename(urlencode($stored_file_name), $bean_id) ||
 161                 self::tryRename($stored_file_name, $bean_id) ||
 162                 self::tryRename($locale->translateCharset( $stored_file_name, 'UTF-8', $locale->getExportCharset()), $bean_id);
 163                 }
 164
 165                 return "upload://$bean_id";
 166         }
 167
 168         /**
 169          * duplicates an already uploaded file in the filesystem.
 170          * @param string old_id ID of original note
 171          * @param string new_id ID of new (copied) note
 172          * @param string filename Filename of file (deprecated)
 173          */
 174         public static function duplicate_file($old_id, $new_id, $file_name)
 175         {
 176                 global $sugar_config;
 177
 178                 // current file system (GUID)
 179                 $source = "upload://$old_id";
 180
 181                 if(!file_exists($source)) {
 182                         // old-style file system (GUID.filename.extension)
 183                         $oldStyleSource = $source.$file_name;
 184                         if(file_exists($oldStyleSource)) {
 185                                 // change to new style
 186                                 if(copy($oldStyleSource, $source)) {
 187                                         // delete the old
 188                                         if(!unlink($oldStyleSource)) {
 189                                                 $GLOBALS['log']->error("upload_file could not unlink [ {$oldStyleSource} ]");
 190                                         }
 191                                 } else {
 192                                         $GLOBALS['log']->error("upload_file could not copy [ {$oldStyleSource} ] to [ {$source} ]");
 193                                 }
 194                         }
 195                 }
 196
 197                 $destination = "upload://$new_id";
 198                 if(!copy($source, $destination)) {
 199                         $GLOBALS['log']->error("upload_file could not copy [ {$source} ] to [ {$destination} ]");
 200                 }
 201         }
 202
 203         /**
 204          * Get upload error from system
 205          * @return string upload error
 206          */
 207         public function get_upload_error()
 208         {
 209             if(isset($this->field_name) && isset($_FILES[$this->field_name]['error'])) {
 210                 return $_FILES[$this->field_name]['error'];
 211             }
 212             return false;
 213         }
 214
 215         /**
 216          * standard PHP file-upload security measures. all variables accessed in a global context
 217          * @return bool True on success
 218          */
 219         public function confirm_upload()
 220         {
 221                 global $sugar_config;
 222
 223                 if(empty($this->field_name) || !isset($_FILES[$this->field_name])) {
 224                     return false;
 225                 }
 226
 227                 if($_FILES[$this->field_name]['error'] != UPLOAD_ERR_OK) {
 228                     if($_FILES[$this->field_name]['error'] != UPLOAD_ERR_NO_FILE) {
 229                 $GLOBALS['log']->error('File upload error: '.self::$filesError[$_FILES[$this->field_name]['error']]);
 230                     }
 231                     return false;
 232                 }
 233
 234                 if(!is_uploaded_file($_FILES[$this->field_name]['tmp_name'])) {
 235                         return false;
 236                 } elseif($_FILES[$this->field_name]['size'] > $sugar_config['upload_maxsize']) {
 237                     $GLOBALS['log']->fatal("ERROR: uploaded file was too big: max filesize: {$sugar_config['upload_maxsize']}");
 238                         return false;
 239                 }
 240
 241                 if(!UploadStream::writable()) {
 242                     $GLOBALS['log']->fatal("ERROR: cannot write to upload directory");
 243                         return false;
 244                 }
 245
 246                 $this->mime_type = $this->getMime($_FILES[$this->field_name]);
 247                 $this->stored_file_name = $this->create_stored_filename();
 248                 $this->temp_file_location = $_FILES[$this->field_name]['tmp_name'];
 249
 250                 return true;
 251         }
 252
 253         /**
 254          * Guess MIME type for file
 255          * @param string $filename
 256          * @return string MIME type
 257          */
 258         function getMimeSoap($filename){
 259
 260                 if( function_exists( 'ext2mime' ) )
 261                 {
 262                         $mime = ext2mime($filename);
 263                 }
 264                 else
 265                 {
 266                         $mime = ' application/octet-stream';
 267                 }
 268                 return $mime;
 269
 270         }
 271
 272         /**
 273          * Get MIME type for uploaded file
 274          * @param array $_FILES_element $_FILES element required
 275          * @return string MIME type
 276          */
 277         function getMime($_FILES_element)
 278         {
 279                 $filename = $_FILES_element['name'];
 280         $file_ext = pathinfo($filename, PATHINFO_EXTENSION);
 281
 282         //If no file extension is available and the mime is octet-stream try to determine the mime type.
 283         $recheckMime = empty($file_ext) && ($_FILES_element['type']  == 'application/octet-stream');
 284
 285                 if( $_FILES_element['type'] && !$recheckMime) {
 286                         $mime = $_FILES_element['type'];
 287                 } elseif( function_exists( 'mime_content_type' ) ) {
 288                         $mime = mime_content_type( $_FILES_element['tmp_name'] );
 289                 } elseif( function_exists( 'ext2mime' ) ) {
 290                         $mime = ext2mime( $_FILES_element['name'] );
 291                 } else {
 292                         $mime = ' application/octet-stream';
 293                 }
 294                 return $mime;
 295         }
 296
 297         /**
 298          * gets note's filename
 299          * @return string
 300          */
 301         function get_stored_file_name()
 302         {
 303                 return $this->stored_file_name;
 304         }
 305
 306         /**
 307          * creates a file's name for preparation for saving
 308          * @return string
 309          */
 310         function create_stored_filename()
 311         {
 312                 global $sugar_config;
 313
 314                 if(!$this->use_soap) {
 315                         $stored_file_name = $_FILES[$this->field_name]['name'];
 316                         $this->original_file_name = $stored_file_name;
 317
 318                         /**
 319                          * cn: bug 8056 - windows filesystems and IIS do not like utf8.  we are forced to urlencode() to ensure that
 320                          * the file is linkable from the browser.  this will stay broken until we move to a db-storage system
 321                          */
 322                         if(is_windows()) {
 323                                 // create a non UTF-8 name encoding
 324                                 // 176 + 36 char guid = windows' maximum filename length
 325                                 $end = (strlen($stored_file_name) > 176) ? 176 : strlen($stored_file_name);
 326                                 $stored_file_name = substr($stored_file_name, 0, $end);
 327                                 $this->original_file_name = $_FILES[$this->field_name]['name'];
 328                         }
 329                     $stored_file_name = str_replace("\\", "", $stored_file_name);
 330                 } else {
 331                         $stored_file_name = $this->stored_file_name;
 332                         $this->original_file_name = $stored_file_name;
 333                 }
 334
 335                 $this->file_ext = pathinfo($stored_file_name, PATHINFO_EXTENSION);
 336         // cn: bug 6347 - fix file extension detection
 337         foreach($sugar_config['upload_badext'] as $badExt) {
 338             if(strtolower($this->file_ext) == strtolower($badExt)) {
 339                 $stored_file_name .= ".txt";
 340                 $this->file_ext="txt";
 341                 break; // no need to look for more
 342             }
 343         }
 344                 return $stored_file_name;
 345         }
 346
 347         /**
 348          * moves uploaded temp file to permanent save location
 349          * @param string bean_id ID of parent bean
 350          * @return bool True on success
 351          */
 352         function final_move($bean_id)
 353         {
 354             $destination = $bean_id;
 355             if(substr($destination, 0, 9) != "upload://") {
 356             $destination = "upload://$bean_id";
 357             }
 358         if($this->use_soap) {
 359                 if(!file_put_contents($destination, $this->file)){
 360                     $GLOBALS['log']->fatal("ERROR: can't save file to $destination");
 361 //FIXME:                        die("ERROR: can't save file to $destination");
 362                 return false;
 363                 }
 364                 } else {
 365                         if(!UploadStream::move_uploaded_file($_FILES[$this->field_name]['tmp_name'], $destination)) {
 366                             $GLOBALS['log']->fatal("ERROR: can't move_uploaded_file to $destination. You should try making the directory writable by the webserver");
 367 // FIXME:                               die("ERROR: can't move_uploaded_file to $destination. You should try making the directory writable by the webserver");
 368                 return false;
 369                         }
 370                 }
 371                 return true;
 372         }
 373
 374         /**
 375          * Upload document to external service
 376          * @param SugarBean $bean Related bean
 377          * @param string $bean_id
 378          * @param string $doc_type
 379          * @param string $file_name
 380          * @param string $mime_type
 381          */
 382         function upload_doc($bean, $bean_id, $doc_type, $file_name, $mime_type)
 383         {
 384                 if(!empty($doc_type)&&$doc_type!='Sugar') {
 385                         global $sugar_config;
 386                 $destination = clean_path($this->get_upload_path($bean_id));
 387                 sugar_rename($destination, str_replace($bean_id, $bean_id.'_'.$file_name, $destination));
 388                 $new_destination = clean_path($this->get_upload_path($bean_id.'_'.$file_name));
 389
 390                     try{
 391                 $this->api = ExternalAPIFactory::loadAPI($doc_type);
 392
 393                 if ( isset($this->api) && $this->api !== false ) {
 394                     $result = $this->api->uploadDoc(
 395                         $bean,
 396                         $new_destination,
 397                         $file_name,
 398                         $mime_type
 399                         );
 400                 } else {
 401                     $result['success'] = FALSE;
 402                     // FIXME: Translate
 403                     $GLOBALS['log']->error("Could not load the requested API (".$doc_type.")");
 404                     $result['errorMessage'] = 'Could not find a proper API';
 405                 }
 406             }catch(Exception $e){
 407                 $result['success'] = FALSE;
 408                 $result['errorMessage'] = $e->getMessage();
 409                 $GLOBALS['log']->error("Caught exception: (".$e->getMessage().") ");
 410             }
 411             if ( !$result['success'] ) {
 412                 sugar_rename($new_destination, str_replace($bean_id.'_'.$file_name, $bean_id, $new_destination));
 413                 $bean->doc_type = 'Sugar';
 414                 // FIXME: Translate
 415                 if ( ! is_array($_SESSION['user_error_message']) )
 416                     $_SESSION['user_error_message'] = array();
 417
 418                 $error_message = isset($result['errorMessage']) ? $result['errorMessage'] : $GLOBALS['app_strings']['ERR_EXTERNAL_API_SAVE_FAIL'];
 419                 $_SESSION['user_error_message'][] = $error_message;
 420
 421             }
 422             else {
 423                 unlink($new_destination);
 424             }
 425         }
 426
 427         }
 428
 429         /**
 430          * returns the path with file name to save an uploaded file
 431          * @param string bean_id ID of the parent bean
 432          * @return string
 433          */
 434         function get_upload_path($bean_id)
 435         {
 436                 $file_name = $bean_id;
 437
 438                 // cn: bug 8056 - mbcs filename in urlencoding > 212 chars in Windows fails
 439                 $end = (strlen($file_name) > 212) ? 212 : strlen($file_name);
 440                 $ret_file_name = substr($file_name, 0, $end);
 441
 442                 return "upload://$ret_file_name";
 443         }
 444
 445         /**
 446          * deletes a file
 447          * @param string bean_id ID of the parent bean
 448          * @param string file_name File's name
 449          */
 450         static public function unlink_file($bean_id,$file_name = '')
 451         {
 452             if(file_exists("upload://$bean_id$file_name")) {
 453             return unlink("upload://$bean_id$file_name");
 454             }
 455     }
 456
 457     /**
 458      * Get upload file location prefix
 459      * @return string prefix
 460      */
 461     public function get_upload_dir()
 462     {
 463         return "upload://";
 464     }
 465
 466     /**
 467      * Return real FS path of the file
 468      * @param string $path
 469      */
 470     public static function realpath($path)
 471     {
 472        if(substr($path, 0, 9) == "upload://") {
 473            $path = UploadStream::path($path);
 474        }
 475        $ret = realpath($path);
 476        return $ret?$ret:$path;
 477     }
 478
 479     /**
 480      * Return path of uploaded file relative to uploads dir
 481      * @param string $path
 482      */
 483     public static function relativeName($path)
 484     {
 485         if(substr($path, 0, 9) == "upload://") {
 486             $path = substr($path, 9);
 487         }
 488         return $path;
 489     }
 490 }
 491
 492 /**
 493  * @internal
 494  * Upload file stream handler
 495  */
 496 class UploadStream
 497 {
 498     const STREAM_NAME = "upload";
 499     protected static $upload_dir;
 500
 501     public static function getDir()
 502     {
 503         if(empty(self::$upload_dir)) {
 504             self::$upload_dir = rtrim($GLOBALS['sugar_config']['upload_dir'], '/\\');
 505             if(empty(self::$upload_dir)) {
 506                 self::$upload_dir = "upload";
 507             }
 508             if(!file_exists(self::$upload_dir)) {
 509                 sugar_mkdir(self::$upload_dir, 0755, true);
 510             }
 511         }
 512         return self::$upload_dir;
 513     }
 514
 515     public static function writable()
 516     {
 517         return is_writable(self::getDir());
 518     }
 519
 520     public function register()
 521     {
 522         stream_register_wrapper(self::STREAM_NAME, __CLASS__);
 523     }
 524
 525     public static function path($path)
 526     {
 527         $path = substr($path, strlen(self::STREAM_NAME)+3); // cut off upload://
 528         $path = str_replace("\\", "/", $path); // canonicalize path
 529         if($path == ".." || substr($path, 0, 3) == "../" || substr($path, -3, 3) == "/.." || strstr($path, "/../")) {
 530                 $GLOBALS['log']->fatal("Invalid uploaded file name supplied: $path");
 531                 return null;
 532         }
 533         return self::getDir()."/".$path;
 534     }
 535
 536     public static function ensureDir($path, $writable = true)
 537     {
 538         $path = self::path($path);
 539         if(!is_dir($path)) {
 540            return sugar_mkdir($path, 0755, true);
 541         }
 542         return true;
 543     }
 544
 545     public function dir_closedir()
 546     {
 547         closedir($this->dirp);
 548     }
 549
 550     public function dir_opendir ($path, $options )
 551     {
 552         $this->dirp = opendir(self::path($path));
 553         return !empty($this->dirp);
 554     }
 555
 556     public function dir_readdir()
 557     {
 558         return readdir($this->dirp);
 559     }
 560
 561     public function dir_rewinddir()
 562     {
 563         return rewinddir($this->dirp);
 564     }
 565
 566     public function mkdir($path, $mode, $options)
 567     {
 568         return mkdir(self::path($path), $mode, ($options&STREAM_MKDIR_RECURSIVE) != 0);
 569     }
 570
 571     public function rename($path_from, $path_to)
 572     {
 573         return rename(self::path($path_from), self::path($path_to));
 574     }
 575
 576     public function rmdir($path, $options)
 577     {
 578         return rmdir(self::path($path));
 579     }
 580
 581     public function stream_cast ($cast_as)
 582     {
 583         return $this->fp;
 584     }
 585
 586     public function stream_close ()
 587     {
 588         fclose($this->fp);
 589         return true;
 590     }
 591
 592     public function stream_eof ()
 593     {
 594         return feof($this->fp);
 595     }
 596    public function stream_flush ()
 597     {
 598         return fflush($this->fp);
 599     }
 600
 601     public function stream_lock($operation)
 602     {
 603         return flock($this->fp, $operation);
 604     }
 605
 606     public function stream_open($path, $mode)
 607     {
 608         $fullpath = self::path($path);
 609         if($mode == 'r') {
 610             $this->fp = fopen($fullpath, $mode);
 611         } else {
 612             // if we will be writing, try to transparently create the directory
 613             $this->fp = @fopen($fullpath, $mode);
 614             if(!$this->fp && !file_exists(dirname($fullpath))) {
 615                 mkdir(dirname($fullpath), 0755, true);
 616                 $this->fp = fopen($fullpath, $mode);
 617             }
 618         }
 619         return !empty($this->fp);
 620     }
 621
 622     public function stream_read($count)
 623     {
 624         return fread($this->fp, $count);
 625     }
 626
 627     public function stream_seek($offset, $whence = SEEK_SET)
 628     {
 629         return fseek($this->fp, $offset, $whence) == 0;
 630     }
 631
 632     public function stream_set_option($option, $arg1, $arg2)
 633     {
 634         return true;
 635     }
 636
 637     public function stream_stat()
 638     {
 639         return fstat($this->fp);
 640     }
 641
 642     public function stream_tell()
 643     {
 644         return ftell($this->fp);
 645     }
 646     public function stream_write($data)
 647     {
 648         return fwrite($this->fp, $data);
 649     }
 650
 651     public function unlink($path)
 652     {
 653         unlink(self::path($path));
 654         return true;
 655     }
 656
 657     public function url_stat($path, $flags)
 658     {
 659         return @stat(self::path($path));
 660     }
 661
 662     public static function move_uploaded_file($upload, $path)
 663     {
 664         return move_uploaded_file($upload, self::path($path));
 665     }
 666 }
 667