include/SugarFields/Fields/File/SugarFieldFile.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Affero General Public License version 3 as published by the
   8  * Free Software Foundation with the addition of the following permission added
   9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  10  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License along with
  19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA.
  22  *
  23  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  24  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  25  *
  26  * The interactive user interfaces in modified source and object code versions
  27  * of this program must display Appropriate Legal Notices, as required under
  28  * Section 5 of the GNU Affero General Public License version 3.
  29  *
  30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  31  * these Appropriate Legal Notices must retain the display of the "Powered by
  32  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  33  * technical reasons, the Appropriate Legal Notices must display the words
  34  * "Powered by SugarCRM".
  35  ********************************************************************************/
  36
  37 require_once('include/SugarFields/Fields/Base/SugarFieldBase.php');
  38
  39 class SugarFieldFile extends SugarFieldBase {
  40     private function fillInOptions(&$vardef,&$displayParams) {
  41         if ( isset($vardef['allowEapm']) && $vardef['allowEapm'] == true ) {
  42             if ( empty($vardef['docType']) ) {
  43                 $vardef['docType'] = 'doc_type';
  44             }
  45             if ( empty($vardef['docId']) ) {
  46                 $vardef['docId'] = 'doc_id';
  47             }
  48             if ( empty($vardef['docUrl']) ) {
  49                 $vardef['docUrl'] = 'doc_url';
  50             }
  51             $displayParams['max_fileupload_size'] = $this->getMaxFileUploadSize();
  52         } else {
  53             $vardef['allowEapm'] = false;
  54         }
  55
  56         // Override the default module
  57         if ( isset($vardef['linkModuleOverride']) ) {
  58             $vardef['linkModule'] = $vardef['linkModuleOverride'];
  59         } else {
  60             $vardef['linkModule'] = '{$module}';
  61         }
  62
  63         // This is needed because these aren't always filled out in the edit/detailview defs
  64         if ( !isset($vardef['fileId']) ) {
  65             if ( isset($displayParams['id']) ) {
  66                 $vardef['fileId'] = $displayParams['id'];
  67             } else {
  68                 $vardef['fileId'] = 'id';
  69             }
  70         }
  71     }
  72
  73
  74         function getDetailViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
  75         $this->fillInOptions($vardef,$displayParams);
  76         return parent::getDetailViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex);
  77     }
  78
  79         function getEditViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex) {
  80         $this->fillInOptions($vardef,$displayParams);
  81
  82         $keys = $this->getAccessKey($vardef,'FILE',$vardef['module']);
  83         $displayParams['accessKeySelect'] = $keys['accessKeySelect'];
  84         $displayParams['accessKeySelectLabel'] = $keys['accessKeySelectLabel'];
  85         $displayParams['accessKeySelectTitle'] = $keys['accessKeySelectTitle'];
  86         $displayParams['accessKeyClear'] = $keys['accessKeyClear'];
  87         $displayParams['accessKeyClearLabel'] = $keys['accessKeyClearLabel'];
  88         $displayParams['accessKeyClearTitle'] = $keys['accessKeyClearTitle'];
  89
  90         return parent::getEditViewSmarty($parentFieldArray, $vardef, $displayParams, $tabindex);
  91     }
  92
  93         public function save(&$bean, $params, $field, $vardef, $prefix = ''){
  94         $fakeDisplayParams = array();
  95         $this->fillInOptions($vardef,$fakeDisplayParams);
  96
  97                 require_once('include/upload_file.php');
  98                 $upload_file = new UploadFile($prefix . $field . '_file');
  99
 100                 //remove file
 101                 if (isset($_REQUEST['remove_file_' . $field]) && $params['remove_file_' . $field] == 1) {
 102                         $upload_file->unlink_file($bean->$field);
 103                         $bean->$field="";
 104                 }
 105
 106                 $move=false;
 107                 if (isset($_FILES[$prefix . $field . '_file']) && $upload_file->confirm_upload())
 108                 {
 109                 $bean->$field = $upload_file->get_stored_file_name();
 110                 $bean->file_mime_type = $upload_file->mime_type;
 111                         $bean->file_ext = $upload_file->file_ext;
 112                         $move=true;
 113                 }
 114
 115         if (!empty($params['isDuplicate']) && $params['isDuplicate'] == 'true' ) {
 116             // This way of detecting duplicates is used in Notes
 117             $old_id = $params['relate_id'];
 118         }
 119         if (!empty($params['duplicateSave']) && !empty($params['duplicateId']) ) {
 120             // It's a duplicate
 121             $old_id = $params['duplicateId'];
 122         }
 123
 124         // Backwards compatibility for fields that still use customCode to handle the file uploads
 125         if ( !$move && empty($old_id) && isset($_FILES['uploadfile']) ) {
 126             $upload_file = new UploadFile('uploadfile');
 127             if ( $upload_file->confirm_upload() ) {
 128                 $bean->$field = $upload_file->get_stored_file_name();
 129                 $bean->file_mime_type = $upload_file->mime_type;
 130                 $bean->file_ext = $upload_file->file_ext;
 131                 $move=true;
 132
 133             }
 134         } else if ( !$move && !empty($old_id) && isset($_REQUEST['uploadfile']) && !isset($_REQUEST[$prefix . $field . '_file']) ) {
 135             // I think we are duplicating a backwards compatibility module.
 136             $upload_file = new UploadFile('uploadfile');
 137         }
 138
 139
 140         if (empty($bean->id)) {
 141             $bean->id = create_guid();
 142             $bean->new_with_id = true;
 143         }
 144
 145                 if ($move) {
 146             $upload_file->final_move($bean->id);
 147             $upload_file->upload_doc($bean, $bean->id, $params[$prefix . $vardef['docType']], $bean->$field, $upload_file->mime_type);
 148         } else if ( ! empty($old_id) ) {
 149             // It's a duplicate, I think
 150
 151             if ( empty($params[$prefix . $vardef['docUrl'] ]) ) {
 152                 $upload_file->duplicate_file($old_id, $bean->id, $bean->$field);
 153             } else {
 154                 $docType = $vardef['docType'];
 155                 $bean->$docType = $params[$prefix . $field . '_old_doctype'];
 156             }
 157                 } else if ( !empty($params[$prefix . $field . '_remoteName']) ) {
 158             // We ain't moving, we might need to do some remote linking
 159             $displayParams = array();
 160             $this->fillInOptions($vardef,$displayParams);
 161
 162             if ( isset($params[$prefix . $vardef['docId']])
 163                  && ! empty($params[$prefix . $vardef['docId']])
 164                  && isset($params[$prefix . $vardef['docType']])
 165                  && ! empty($params[$prefix . $vardef['docType']])
 166                 ) {
 167                 $bean->$field = $params[$prefix . $field . '_remoteName'];
 168
 169                 require_once('include/utils/file_utils.php');
 170                 $extension = get_file_extension($bean->$field);
 171                 if(!empty($extension))
 172                 {
 173                         $bean->file_ext = $extension;
 174                         $bean->file_mime_type = get_mime_content_type_from_filename($bean->$field);
 175                 }
 176             }
 177         }
 178
 179         if ( $vardef['allowEapm'] == true && empty($bean->$field) ) {
 180             $GLOBALS['log']->info("The $field is empty, clearing out the lot");
 181             // Looks like we are emptying this out
 182             $clearFields = array('docId', 'docType', 'docUrl', 'docDirectUrl');
 183             foreach ( $clearFields as $clearMe ) {
 184                 if ( ! isset($vardef[$clearMe]) ) {
 185                     continue;
 186                 }
 187                 $clearField = $vardef[$clearMe];
 188                 $bean->$clearField = '';
 189             }
 190         }
 191         }
 192
 193         /**
 194          * Takes the size from the php.ini and converts it to bytes
 195          *
 196          * @param string $size
 197          * @return int
 198          */
 199         protected function convertIniSizeToBytes($size)
 200         {
 201                 $ret_size = $size;
 202                 switch (substr (strtolower($size), -1)){
 203                 case 'k':
 204                     $ret_size = (int)$size * 1024;
 205                     break;
 206                 case 'm':
 207                     $ret_size = (int)$size * 1048576;
 208                     break;
 209                 case 'g':
 210                     $ret_size = (int)$size * 1073741824;
 211                     break;
 212                 }
 213
 214                 return $ret_size;
 215         }
 216
 217         /**
 218          * Converts the size into a more reader friendly format
 219          *
 220          * @param int $size
 221          * @return string
 222          */
 223         protected function getReaderFriendlySize($size)
 224     {
 225                 if(($size / 1024) < 1024) {
 226                         $size = number_format(($size / 1024), 2);
 227                         $size .= ' kb';
 228                 }
 229                 else if(($size / 1048576) < 1024) {
 230                         $size = number_format(($size / 1048576), 2);
 231                         $size .= ' mb';
 232                 }
 233                 else if(($size / 1073741824) < 1024) {
 234                         $size = number_format(($size / 1073741824), 2);
 235                         $size .= ' gb';
 236                 }
 237
 238                 return $size;
 239         }
 240
 241         /**
 242          * Returns a string that represents the max file size that can be uploaded.
 243          *
 244          * @return string
 245          */
 246         protected function getMaxFileUploadSize()
 247         {
 248                 $max_upload_size = min($this->convertIniSizeToBytes(ini_get('post_max_size')), $this->convertIniSizeToBytes(ini_get('upload_max_filesize')));
 249                 $max_upload_size = min($GLOBALS['sugar_config']['upload_maxsize'],$max_upload_size);
 250
 251                 return $this->getReaderFriendlySize($max_upload_size);
 252         }
 253 }