include/Dashlets/DashletCacheBuilder.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  * Description: Handles Generic Widgets
  41  * Portions created by SugarCRM are Copyright (C) SugarCRM, Inc.
  42  * All Rights Reserved.
  43  * Contributor(s): ______________________________________..
  44  ********************************************************************************/
  45
  46
  47
  48
  49 class DashletCacheBuilder {
  50
  51     /**
  52      * Builds the cache of Dashlets by scanning the system
  53      */
  54     function buildCache() {
  55         global $beanList;
  56         $dashletFiles = array();
  57         $dashletFilesCustom = array();
  58
  59         getFiles($dashletFiles, 'modules', '/^.*\/Dashlets\/[^\.]*\.php$/');
  60         getFiles($dashletFilesCustom, 'custom/modules', '/^.*\/Dashlets\/[^\.]*\.php$/');
  61         $cacheDir = create_cache_directory('dashlets/');
  62         $allDashlets = array_merge($dashletFiles, $dashletFilesCustom);
  63         $dashletFiles = array();
  64         foreach($allDashlets as $num => $file) {
  65             if(substr_count($file, '.meta') == 0) { // ignore meta data files
  66                 $class = substr($file, strrpos($file, '/') + 1, -4);
  67                 $dashletFiles[$class] = array();
  68                 $dashletFiles[$class]['file'] = $file;
  69                 $dashletFiles[$class]['class'] = $class;
  70                 if(is_file(preg_replace('/(.*\/.*)(\.php)/Uis', '$1.meta$2', $file))) { // is there an associated meta data file?
  71                     $dashletFiles[$class]['meta'] = preg_replace('/(.*\/.*)(\.php)/Uis', '$1.meta$2', $file);
  72                     require($dashletFiles[$class]['meta']);
  73                     if ( isset($dashletMeta[$class]['module']) )
  74                         $dashletFiles[$class]['module'] = $dashletMeta[$class]['module'];
  75                 }
  76
  77                 $filesInDirectory = array();
  78                 getFiles($filesInDirectory, substr($file, 0, strrpos($file, '/')), '/^.*\/Dashlets\/[^\.]*\.icon\.(jpg|jpeg|gif|png)$/i');
  79                 if(!empty($filesInDirectory)) {
  80                     $dashletFiles[$class]['icon'] = $filesInDirectory[0]; // take the first icon we see
  81                 }
  82             }
  83         }
  84
  85         write_array_to_file('dashletsFiles', $dashletFiles, $cacheDir . 'dashlets.php');
  86     }
  87 }
  88 ?>