tests/ModuleInstall/ModuleScannerTest.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2013 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 'ModuleInstall/ModuleScanner.php';
  38
  39 class ModuleScannerTest extends Sugar_PHPUnit_Framework_TestCase
  40 {
  41     var $fileLoc;
  42
  43         public function setUp()
  44         {
  45         $this->fileLoc = "cache/moduleScannerTemp.php";
  46         }
  47
  48         public function tearDown()
  49         {
  50                 if (is_file($this->fileLoc))
  51                         unlink($this->fileLoc);
  52         }
  53
  54         public function phpSamples()
  55         {
  56             return array(
  57                 array("<?php echo blah;", true),
  58                 array("<? echo blah;", true),
  59                 array("blah <? echo blah;", true),
  60                 array("blah <?xml echo blah;", true),
  61                 array("<?xml version=\"1.0\"></xml>", false),
  62                 array("<?xml \n echo blah;", true),
  63                 array("<?xml version=\"1.0\"><? blah ?></xml>", true),
  64                 array("<?xml version=\"1.0\"><?php blah ?></xml>", true),
  65                 );
  66         }
  67
  68         /**
  69          * @dataProvider phpSamples
  70          */
  71         public function testPHPFile($content, $is_php)
  72         {
  73         $ms = new MockModuleScanner();
  74             $this->assertEquals($is_php, $ms->isPHPFile($content), "Bad PHP file result");
  75         }
  76
  77         public function testFileTemplatePass()
  78     {
  79
  80         $fileModContents = <<<EOQ
  81 <?PHP
  82 require_once('include/SugarObjects/templates/file/File.php');
  83
  84 class testFile_sugar extends File {
  85         function fileT_testFiles_sugar(){
  86                 parent::File();
  87                 \$this->file = new File();
  88                 \$file = "file";
  89         }
  90 }
  91 ?>
  92 EOQ;
  93                 file_put_contents($this->fileLoc, $fileModContents);
  94                 $ms = new ModuleScanner();
  95                 $errors = $ms->scanFile($this->fileLoc);
  96                 $this->assertTrue(empty($errors));
  97     }
  98
  99         public function testFileFunctionFail()
 100     {
 101
 102         $fileModContents = <<<EOQ
 103 <?PHP
 104 require_once('include/SugarObjects/templates/file/File.php');
 105
 106 class testFile_sugar extends File {
 107         function fileT_testFiles_sugar(){
 108                 parent::File();
 109                 \$this->file = new File();
 110                 \$file = file('test.php');
 111
 112         }
 113 }
 114 ?>
 115 EOQ;
 116                 file_put_contents($this->fileLoc, $fileModContents);
 117                 $ms = new ModuleScanner();
 118                 $errors = $ms->scanFile($this->fileLoc);
 119                 $this->assertTrue(!empty($errors));
 120     }
 121
 122         public function testCallUserFunctionFail()
 123     {
 124
 125         $fileModContents = <<<EOQ
 126 <?PHP
 127         call_user_func("sugar_file_put_contents", "test2.php", "test");
 128 ?>
 129 EOQ;
 130                 file_put_contents($this->fileLoc, $fileModContents);
 131                 $ms = new ModuleScanner();
 132                 $errors = $ms->scanFile($this->fileLoc);
 133                 $this->assertTrue(!empty($errors));
 134     }
 135
 136
 137         public function testCallMethodObjectOperatorFail()
 138     {
 139
 140         $fileModContents = <<<EOQ
 141 <?PHP
 142     //doesnt matter what the class name is, what matters is use of the banned method, setlevel
 143         \$GlobalLoggerClass->setLevel();
 144 ?>
 145 EOQ;
 146                 file_put_contents($this->fileLoc, $fileModContents);
 147                 $ms = new ModuleScanner();
 148                 $errors = $ms->scanFile($this->fileLoc);
 149                 $this->assertNotEmpty($errors, 'There should have been an error caught for use of "->setLevel()');
 150     }
 151
 152         public function testCallMethodDoubleColonFail()
 153     {
 154
 155         $fileModContents = <<<EOQ
 156 <?PHP
 157     //doesnt matter what the class name is, what matters is use of the banned method, setlevel
 158         \$GlobalLoggerClass::setLevel();
 159 ?>
 160 EOQ;
 161                 file_put_contents($this->fileLoc, $fileModContents);
 162                 $ms = new ModuleScanner();
 163                 $errors = $ms->scanFile($this->fileLoc);
 164                 $this->assertNotEmpty($errors, 'There should have been an error caught for use of "::setLevel()');
 165     }
 166
 167     /**
 168      * Bug 56717
 169      *
 170      * When ModuleScanner is enabled, handle bars templates are invalidating published
 171      * package installation.
 172      *
 173      * @group bug56717
 174      */
 175     public function testBug56717ValidExtsAllowed() {
 176         // Allowed file names
 177         $allowed = array(
 178             'php' => 'test.php',
 179             'htm' => 'test.htm',
 180             'xml' => 'test.xml',
 181             'hbs' => 'test.hbs',
 182             'config' => 'custom/config.php',
 183         );
 184
 185         // Disallowed file names
 186         $notAllowed = array(
 187             'docx' => 'test.docx',
 188             'docx(2)' => '../sugarcrm.xml/../sugarcrm/test.docx',
 189             'java' => 'test.java',
 190             'phtm' => 'test.phtm',
 191             'md5' => 'files.md5',
 192             'md5(2)' => '../sugarcrm/files.md5',
 193
 194         );
 195
 196         // Get our scanner
 197         $ms = new ModuleScanner();
 198
 199         // Test valid
 200         foreach ($allowed as $ext => $file) {
 201             $valid = $ms->isValidExtension($file);
 202             $this->assertTrue($valid, "The $ext extension should be valid on $file but the ModuleScanner is saying it is not");
 203         }
 204
 205         // Test not valid
 206         foreach ($notAllowed as $ext => $file) {
 207             $valid = $ms->isValidExtension($file);
 208             $this->assertFalse($valid, "The $ext extension should not be valid on $file but the ModuleScanner is saying it is");
 209         }
 210     }
 211
 212     public function testConfigChecks()
 213     {
 214             $isconfig = array(
 215             'config.php',
 216             'config_override.php',
 217             'custom/../config_override.php',
 218             'custom/.././config.php',
 219             );
 220
 221         // Disallowed file names
 222         $notconfig = array(
 223             'custom/config.php',
 224             'custom/modules/config.php',
 225             'cache/config_override.php',
 226             'modules/Module/config.php'
 227         );
 228
 229         // Get our scanner
 230         $ms = new ModuleScanner();
 231
 232         // Test valid
 233         foreach ($isconfig as $file) {
 234             $valid = $ms->isConfigFile($file);
 235             $this->assertTrue($valid, "$file should be recognized as config file");
 236         }
 237
 238         // Test not valid
 239         foreach ($notconfig as $ext => $file) {
 240             $valid = $ms->isConfigFile($file);
 241             $this->assertFalse($valid, "$file should not be recognized as config file");
 242         }
 243     }
 244
 245     /**
 246      * @group bug58072
 247      */
 248         public function testLockConfig()
 249     {
 250
 251         $fileModContents = <<<EOQ
 252 <?PHP
 253         \$GLOBALS['sugar_config']['moduleInstaller']['test'] = true;
 254         \$manifest = array();
 255         \$installdefs = array();
 256 ?>
 257 EOQ;
 258                 file_put_contents($this->fileLoc, $fileModContents);
 259                 $ms = new MockModuleScanner();
 260                 $ms->config['test'] = false;
 261                 $ms->lockConfig();
 262                 MSLoadManifest($this->fileLoc);
 263                 $errors = $ms->checkConfig($this->fileLoc);
 264                 $this->assertTrue(!empty($errors), "Not detected config change");
 265                 $this->assertFalse($ms->config['test'], "config was changed");
 266     }
 267 }
 268
 269 class MockModuleScanner extends  ModuleScanner
 270 {
 271     public $config;
 272     public function isPHPFile($contents) {
 273         return parent::isPHPFile($contents);
 274     }
 275 }
 276