modules/Import/ImportCacheFiles.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3
   4 /*********************************************************************************
   5  * SugarCRM Community Edition is a customer relationship management program developed by
   6  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or modify it under
   9  * the terms of the GNU Affero General Public License version 3 as published by the
  10  * Free Software Foundation with the addition of the following permission added
  11  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  12  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  13  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  14  *
  15  * This program is distributed in the hope that it will be useful, but WITHOUT
  16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  17  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  18  * details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License along with
  21  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  22  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  23  * 02110-1301 USA.
  24  *
  25  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  26  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  27  *
  28  * The interactive user interfaces in modified source and object code versions
  29  * of this program must display Appropriate Legal Notices, as required under
  30  * Section 5 of the GNU Affero General Public License version 3.
  31  *
  32  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  33  * these Appropriate Legal Notices must retain the display of the "Powered by
  34  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  35  * technical reasons, the Appropriate Legal Notices must display the words
  36  * "Powered by SugarCRM".
  37  ********************************************************************************/
  38
  39 /*********************************************************************************
  40
  41  * Description: Static class to that is used to get the filenames for the various
  42  * cache files used
  43  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  44  * All Rights Reserved.
  45  ********************************************************************************/
  46
  47 class ImportCacheFiles
  48 {
  49     /**
  50      * Returns the filename for a temporary file
  51      *
  52      * @param  string $type string to prepend to the filename, typically to indicate the file's use
  53      * @return string filename
  54      */
  55     private static function _createFileName(
  56         $type = 'misc'
  57         )
  58     {
  59         global $sugar_config, $current_user;
  60
  61         if( !is_dir($sugar_config['import_dir']) )
  62             create_cache_directory(preg_replace('/^cache\//','',$sugar_config['import_dir']));
  63
  64         if( !is_writable($sugar_config['import_dir']) )
  65             return false;
  66
  67         return "{$sugar_config['import_dir']}{$type}_{$current_user->id}.csv";
  68     }
  69
  70     /**
  71      * Returns the duplicates filename
  72      *
  73      * @return string filename
  74      */
  75     public static function getDuplicateFileName()
  76     {
  77         return self::_createFileName("dupes");
  78     }
  79
  80     /**
  81      * Returns the error filename
  82      *
  83      * @return string filename
  84      */
  85     public static function getErrorFileName()
  86     {
  87         return self::_createFileName("error");
  88     }
  89
  90     /**
  91      * Returns the error records filename
  92      *
  93      * @return string filename
  94      */
  95     public static function getErrorRecordsFileName()
  96     {
  97         return self::_createFileName("errorrecords");
  98     }
  99
 100     /**
 101      * Returns the status filename
 102      *
 103      * @return string filename
 104      */
 105     public static function getStatusFileName()
 106     {
 107         return self::_createFileName("status");
 108     }
 109
 110     /**
 111      * Clears out all cache files in the $sugar_config['import_dir'] directory
 112      */
 113     public static function clearCacheFiles()
 114     {
 115         global $sugar_config;
 116
 117         if ( is_dir($sugar_config['import_dir']) ) {
 118             $files = dir($sugar_config['import_dir']);
 119             while (false !== ($file = $files->read())) {
 120                 if ( !is_dir($file) && stristr($file,'.csv') )
 121                     unlink($sugar_config['import_dir'].$file);
 122             }
 123         }
 124     }
 125 }