modules/UpgradeWizard/UpgradeRemoval.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-2012 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  * UpgradeRemoval.php
  41  *
  42  * This is the base class to support removing files during an upgrade process.
  43  * To support custom removal of files during an upgrade process take the following steps:
  44  *
  45  * 1) Extend this class and save the PHP file name to be the same as the class name
  46  * 2) Override the getFilesToRemove method to return an Array of files/directories to remove
  47  * 3) Place this PHP file in custom/scripts/files_to_remove directory of your SugarCRM install
  48  *
  49  * The UpgradeRemoval instance will be invoked from the unlinkUpgradeFiles method of uw_utils.php
  50  */
  51 class UpgradeRemoval
  52 {
  53
  54 /**
  55  * getFilesToRemove
  56  * Return array of files/directories to remove.  Default implementation returns empty array.
  57  *
  58  * @param int $version integer value of original version to be upgraded
  59  * @return mixed $files Array of files/directories to remove
  60  */
  61 public function getFilesToRemove($version)
  62 {
  63         return array();
  64 }
  65
  66 /**
  67  * processFilesToRemove
  68  * This method handles removing the array of files/directories specified.
  69  *
  70  * @param mixed $files
  71  */
  72 public function processFilesToRemove($files=array())
  73 {
  74         if(empty($files) || !is_array($files))
  75         {
  76                 return;
  77         }
  78
  79         require_once('include/dir_inc.php');
  80
  81         if(!file_exists('custom/backup'))
  82         {
  83            mkdir_recursive('custom/backup');
  84         }
  85
  86         foreach($files as $file)
  87         {
  88                 if(file_exists($file))
  89                 {
  90                         $this->backup($file);
  91                         if(is_dir($file))
  92                         {
  93                           rmdir_recursive($file);
  94                         } else {
  95                           unlink($file);
  96                         }
  97             }
  98         }
  99 }
 100
 101
 102 /**
 103  * backup
 104  * Private method to handle backing up the file to custom/backup directory
 105  *
 106  * @param $file File or directory to backup to custom/backup directory
 107  */
 108 protected function backup($file)
 109 {
 110         $basename = basename($file);
 111         $basepath = str_replace($basename, '', $file);
 112
 113         if(!empty($basepath) && !file_exists('custom/backup/' . $basepath))
 114         {
 115            mkdir_recursive('custom/backup/' . $basepath);
 116         }
 117
 118         if(is_dir($file))
 119         {
 120         copy_recursive($file, 'custom/backup/' . $file);
 121         } else {
 122                 copy($file, 'custom/backup/' . $file);
 123         }
 124 }
 125
 126 }
 127 ?>