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      * Cache file names
  51      */
  52     const FILE_MISCELLANEOUS      = 'misc';
  53     const FILE_DUPLICATES         = 'dupes';
  54     const FILE_DUPLICATES_DISPLAY = 'dupesdisplay';
  55     const FILE_ERRORS             = 'error';
  56     const FILE_ERROR_RECORDS      = 'errorrecords';
  57     const FILE_ERROR_RECORDS_ONLY = 'errorrecordsonly';
  58     const FILE_STATUS             = 'status';
  59     /**#@-*/
  60
  61     /**
  62      * List of all cache file names
  63      *
  64      * @var array
  65      */
  66     protected static $all_files = array(
  67         self::FILE_MISCELLANEOUS,
  68         self::FILE_DUPLICATES,
  69         self::FILE_DUPLICATES_DISPLAY,
  70         self::FILE_ERRORS,
  71         self::FILE_ERROR_RECORDS,
  72         self::FILE_ERROR_RECORDS_ONLY,
  73         self::FILE_STATUS,
  74     );
  75
  76     /**
  77      * Get import directory name
  78      * @return string
  79      */
  80     public static function getImportDir()
  81     {
  82         return "upload://import";
  83     }
  84
  85     /**
  86      * Returns the filename for a temporary file
  87      *
  88      * @param  string $type string to prepend to the filename, typically to indicate the file's use
  89      * @return string filename
  90      */
  91     private static function _createFileName($type = self::FILE_MISCELLANEOUS)
  92     {
  93         global $current_user;
  94         $importdir = self::getImportDir();
  95         // ensure dir exists and writable
  96         UploadStream::ensureDir($importdir, true);
  97
  98         return "$importdir/{$type}_{$current_user->id}.csv";
  99     }
 100
 101     /**
 102      * Ensure that all cache files are writable or can be created
 103      *
 104      * @return bool
 105      */
 106     public static function ensureWritable()
 107     {
 108         foreach (self::$all_files as $type)
 109         {
 110             $filename = self::_createFileName($type);
 111             if (file_exists($filename) && !is_writable($filename))
 112             {
 113                 return false;
 114             }
 115             elseif (!is_writable(dirname($filename)))
 116             {
 117                 return false;
 118             }
 119         }
 120         return true;
 121     }
 122
 123     /**
 124      * Returns the duplicates filename (the ones used to download to csv file
 125      *
 126      * @return string filename
 127      */
 128     public static function getDuplicateFileName()
 129     {
 130         return self::_createFileName(self::FILE_DUPLICATES);
 131     }
 132
 133     /**
 134      * Returns the duplicates display filename (the one used for display in html)
 135      *
 136      * @return string filename
 137      */
 138     public static function getDuplicateFileDisplayName()
 139     {
 140         return self::_createFileName(self::FILE_DUPLICATES_DISPLAY);
 141     }
 142
 143     /**
 144      * Returns the error filename
 145      *
 146      * @return string filename
 147      */
 148     public static function getErrorFileName()
 149     {
 150         return self::_createFileName(self::FILE_ERRORS);
 151     }
 152
 153     /**
 154      * Returns the error records filename
 155      *
 156      * @return string filename
 157      */
 158     public static function getErrorRecordsFileName()
 159     {
 160         return self::_createFileName(self::FILE_ERROR_RECORDS);
 161     }
 162
 163     /**
 164      * Returns the error records filename
 165      *
 166      * @return string filename
 167      */
 168     public static function getErrorRecordsWithoutErrorFileName()
 169     {
 170         return self::_createFileName(self::FILE_ERROR_RECORDS_ONLY);
 171     }
 172
 173     /**
 174      * Returns the status filename
 175      *
 176      * @return string filename
 177      */
 178     public static function getStatusFileName()
 179     {
 180         return self::_createFileName(self::FILE_STATUS);
 181     }
 182
 183     /**
 184      * Clears out all cache files in the import directory
 185      */
 186     public static function clearCacheFiles()
 187     {
 188         global $sugar_config;
 189         $importdir = self::getImportDir();
 190         if ( is_dir($importdir) ) {
 191             $files = dir($importdir);
 192             while (false !== ($file = $files->read())) {
 193                 if ( !is_dir($file) && stristr($file,'.csv') )
 194                     unlink("$importdir/$file");
 195             }
 196         }
 197     }
 198 }