mirror of
https://github.com/Pathduck/gallery3.git
synced 2026-03-06 22:25:48 -05:00
345 lines
13 KiB
PHP
345 lines
13 KiB
PHP
<?php defined("SYSPATH") or die("No direct script access.");
|
|
/**
|
|
* Gallery - a web based photo album viewer and editor
|
|
* Copyright (C) 2000-2013 Bharat Mediratta
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or (at
|
|
* your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
require_once(MODPATH . "gallery/tests/Gallery_Filters.php");
|
|
|
|
class File_Structure_Test extends Gallery_Unit_Test_Case {
|
|
public function no_trailing_closing_php_tag_test() {
|
|
$dir = new GalleryCodeFilterIterator(
|
|
new RecursiveIteratorIterator(new RecursiveDirectoryIterator(DOCROOT)));
|
|
$count = 0;
|
|
foreach ($dir as $file) {
|
|
$count++;
|
|
if (!preg_match("|\.html\.php$|", $file->getPathname())) {
|
|
$this->assert_false(
|
|
preg_match('/\?\>\s*$/', file_get_contents($file)),
|
|
"{$file->getPathname()} ends in ?>");
|
|
}
|
|
}
|
|
|
|
$this->assert_true($count > 500, "We should have analyzed at least this 500 files");
|
|
$this->assert_true($count < 1000, "We shouldn't be shipping 1000 files!");
|
|
}
|
|
|
|
public function view_files_correct_suffix_test() {
|
|
$dir = new GalleryCodeFilterIterator(
|
|
new RecursiveIteratorIterator(new RecursiveDirectoryIterator(DOCROOT)));
|
|
foreach ($dir as $file) {
|
|
if (strpos($file, "views/kohana/error.php")) {
|
|
continue;
|
|
}
|
|
|
|
if (strpos($file, "views")) {
|
|
$this->assert_true(
|
|
preg_match("#/views/.*?\.(html|mrss|txt|json)\.php$#", $file->getPathname()),
|
|
"{$file->getPathname()} should end in .{html,mrss,txt,json}.php");
|
|
}
|
|
}
|
|
}
|
|
|
|
public function no_windows_line_endings_test() {
|
|
$dir = new GalleryCodeFilterIterator(
|
|
new RecursiveIteratorIterator(new RecursiveDirectoryIterator(DOCROOT)));
|
|
foreach ($dir as $file) {
|
|
if (preg_match("/\.(php|css|html|js)$/", $file)) {
|
|
foreach (file($file) as $line) {
|
|
$this->assert_true(substr($line, -2) != "\r\n", "$file has windows style line endings");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
private function _check_view_preamble($path, &$errors) {
|
|
$expected_2 = null;
|
|
// The preamble for views is a single line that prevents direct script access
|
|
if (strpos($path, SYSPATH) === 0) {
|
|
// Kohana preamble
|
|
$expected = "<?php defined('SYSPATH') OR die('No direct access allowed.'); ?>\n";
|
|
$expected_2 = "<?php defined('SYSPATH') OR die('No direct access allowed.');\n"; // error.php
|
|
} else {
|
|
// Gallery preamble
|
|
// @todo use the same preamble for both!
|
|
$expected = "<?php defined(\"SYSPATH\") or die(\"No direct script access.\") ?>\n";
|
|
}
|
|
|
|
$fp = fopen($path, "r");
|
|
$actual = fgets($fp);
|
|
fclose($fp);
|
|
|
|
if ($expected != $actual && $expected_2 != $actual) {
|
|
$errors[] = "$path:1\n expected:\n\t$expected\n actual:\n\t$actual";
|
|
}
|
|
}
|
|
|
|
private function _check_php_preamble($path, &$errors) {
|
|
$expected_2 = null; $expected_3 = null; $expected_4 = null;
|
|
if (strpos($path, SYSPATH) === 0 ||
|
|
strpos($path, MODPATH . "unit_test") === 0) {
|
|
// Kohana: we only care about the first line
|
|
$fp = fopen($path, "r");
|
|
$actual = array(fgets($fp));
|
|
fclose($fp);
|
|
$expected = array("<?php defined('SYSPATH') OR die('No direct script access.');\n");
|
|
$expected_2 = array("<?php defined('SYSPATH') OR die('No direct access allowed.');\n");
|
|
$expected_3 = array("<?php defined('SYSPATH') or die('No direct access allowed.');\n");
|
|
$expected_4 = array("<?php defined('SYSPATH') or die('No direct script access.');\n");
|
|
} else if (strpos($path, MODPATH . "forge") === 0 ||
|
|
strpos($path, MODPATH . "exif/lib") === 0 ||
|
|
strpos($path, MODPATH . "gallery/vendor/joomla") === 0 ||
|
|
strpos($path, MODPATH . "gallery_unit_test/vendor") === 0 ||
|
|
strpos($path, MODPATH . "gallery/lib/HTMLPurifier") === 0 ||
|
|
$path == MODPATH . "user/lib/PasswordHash.php" ||
|
|
$path == DOCROOT . "var/database.php") {
|
|
// 3rd party module security-only preambles, similar to Gallery's
|
|
$expected = array("<?php defined(\"SYSPATH\") or die(\"No direct access allowed.\");\n");
|
|
$expected_2 = array("<?php defined('SYSPATH') OR die('No direct access allowed.');\n");
|
|
$expected_3 = array("<?php defined(\"SYSPATH\") or die(\"No direct script access.\");\n");
|
|
$fp = fopen($path, "r");
|
|
$actual = array(fgets($fp));
|
|
fclose($fp);
|
|
} else if (strpos($path, DOCROOT . "var/logs") === 0) {
|
|
// var/logs has the kohana one-liner preamble
|
|
$expected = array("<?php defined('SYSPATH') or die('No direct script access.'); ?>\n");
|
|
$fp = fopen($path, "r");
|
|
$actual = array(fgets($fp));
|
|
fclose($fp);
|
|
} else if (strpos($path, DOCROOT . "var") === 0) {
|
|
// Anything else under var has the Gallery one-liner
|
|
$expected = array("<?php defined(\"SYSPATH\") or die(\"No direct script access.\") ?>\n");
|
|
$fp = fopen($path, "r");
|
|
$actual = array(fgets($fp));
|
|
fclose($fp);
|
|
} else {
|
|
// Gallery: we care about the entire copyright
|
|
$actual = $this->_get_preamble($path);
|
|
$expected = array(
|
|
"<?php defined(\"SYSPATH\") or die(\"No direct script access.\");",
|
|
"/**",
|
|
" * Gallery - a web based photo album viewer and editor",
|
|
" * Copyright (C) 2000-2013 Bharat Mediratta",
|
|
" *",
|
|
" * This program is free software; you can redistribute it and/or modify",
|
|
" * it under the terms of the GNU General Public License as published by",
|
|
" * the Free Software Foundation; either version 2 of the License, or (at",
|
|
" * your option) any later version.",
|
|
" *",
|
|
" * This program is distributed in the hope that it will be useful, but",
|
|
" * WITHOUT ANY WARRANTY; without even the implied warranty of",
|
|
" * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU",
|
|
" * General Public License for more details.",
|
|
" *",
|
|
" * You should have received a copy of the GNU General Public License",
|
|
" * along with this program; if not, write to the Free Software",
|
|
" * Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.",
|
|
" */",
|
|
);
|
|
}
|
|
if ($expected != $actual && $expected_2 != $actual && $expected_3 != $actual && $expected_4 != $actual) {
|
|
$errors[] = "$path:1\n expected\n\t" . join("\n\t", $expected) .
|
|
"\n actual:\n\t" . join("\n\t", $actual);
|
|
}
|
|
}
|
|
|
|
public function code_files_start_with_preamble_test() {
|
|
$dir = new PhpCodeFilterIterator(
|
|
new RecursiveIteratorIterator(new RecursiveDirectoryIterator(DOCROOT)));
|
|
|
|
$errors = array();
|
|
foreach ($dir as $file) {
|
|
$path = $file->getPathname();
|
|
switch ($path) {
|
|
case DOCROOT . "installer/database_config.php":
|
|
case DOCROOT . "installer/init_var.php":
|
|
// Special case views
|
|
$this->_check_view_preamble($path, $errors);
|
|
break;
|
|
|
|
case DOCROOT . "index.php":
|
|
case DOCROOT . "installer/index.php":
|
|
// Front controllers
|
|
break;
|
|
|
|
case DOCROOT . "lib/uploadify/uploadify.swf.php":
|
|
case DOCROOT . "lib/uploadify/uploadify.allglyphs.swf.php":
|
|
case DOCROOT . "lib/mediaelementjs/flashmediaelement.swf.php":
|
|
// SWF wrappers - directly accessible
|
|
break;
|
|
|
|
case DOCROOT . "local.php":
|
|
// Special case optional file, not part of the codebase
|
|
break;
|
|
|
|
default:
|
|
if (preg_match("/vendor/", $path)) {
|
|
# including unmodified 3rd party code
|
|
} elseif (preg_match("/modules\/(autorotate|movie_resized)/", $path)) {
|
|
# including unmodified 3rd party code
|
|
} elseif (preg_match("/views/", $path)) {
|
|
$this->_check_view_preamble($path, $errors);
|
|
} else {
|
|
$this->_check_php_preamble($path, $errors);
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($errors) {
|
|
$this->assert_false(true, "Preamble errors:\n" . join("\n", $errors));
|
|
}
|
|
}
|
|
|
|
public function no_tabs_in_our_code_test() {
|
|
$dir = new PhpCodeFilterIterator(
|
|
new GalleryCodeFilterIterator(
|
|
new RecursiveIteratorIterator(
|
|
new RecursiveDirectoryIterator(DOCROOT))));
|
|
$errors = array();
|
|
foreach ($dir as $file) {
|
|
$file_as_string = file_get_contents($file);
|
|
if (preg_match('/\t/', $file_as_string)) {
|
|
foreach (explode("\n", $file_as_string) as $l => $line) {
|
|
if (preg_match('/\t/', $line)) {
|
|
$errors[] = "$file:$l has tab(s) ($line)";
|
|
}
|
|
}
|
|
}
|
|
$file_as_string = null;
|
|
}
|
|
if ($errors) {
|
|
$this->assert_false(true, "tab(s) found:\n" . join("\n", $errors));
|
|
}
|
|
}
|
|
|
|
private function _get_preamble($file) {
|
|
$lines = file($file);
|
|
$copy = array();
|
|
for ($i = 0; $i < count($lines); $i++) {
|
|
$copy[] = rtrim($lines[$i]);
|
|
if (!strncmp($lines[$i], ' */', 3)) {
|
|
return $copy;
|
|
}
|
|
}
|
|
return $copy;
|
|
}
|
|
|
|
public function helpers_are_static_test() {
|
|
$dir = new PhpCodeFilterIterator(
|
|
new GalleryCodeFilterIterator(
|
|
new RecursiveIteratorIterator(
|
|
new RecursiveDirectoryIterator(DOCROOT))));
|
|
foreach ($dir as $file) {
|
|
if (basename(dirname($file)) == "helpers") {
|
|
foreach (file($file) as $line) {
|
|
$this->assert_true(
|
|
!preg_match("/\sfunction\s.*\(/", $line) ||
|
|
preg_match("/^\s*(private static function _|static function)/", $line),
|
|
"should be \"static function foo\" or \"private static function _foo\":\n" .
|
|
"$file\n$line\n");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
public function module_info_is_well_formed_test() {
|
|
$info_files = array_merge(
|
|
glob("modules/*/module.info"),
|
|
glob("themes/*/module.info"));
|
|
|
|
$errors = array();
|
|
foreach ($info_files as $file) {
|
|
foreach (file($file) as $line) {
|
|
$parts = explode("=", $line, 2);
|
|
if (isset($parts[1])) {
|
|
$values[trim($parts[0])] = trim($parts[1]);
|
|
}
|
|
}
|
|
|
|
$module = dirname($file);
|
|
// Certain keys must exist
|
|
foreach (array("name", "description", "version") as $key) {
|
|
if (!array_key_exists($key, $values)) {
|
|
$errors[] = "$module: missing key $key";
|
|
}
|
|
}
|
|
|
|
// Any values containing spaces must be quoted
|
|
foreach ($values as $key => $value) {
|
|
if (strpos($value, " ") !== false && !preg_match('/^".*"$/', $value)) {
|
|
$errors[] = "$module: value for $key must be quoted";
|
|
}
|
|
}
|
|
|
|
// The file must parse
|
|
if (!is_array(parse_ini_file($file))) {
|
|
$errors[] = "$module: info file is not parseable";
|
|
}
|
|
}
|
|
if ($errors) {
|
|
$this->assert_true(false, $errors);
|
|
}
|
|
}
|
|
|
|
public function all_public_functions_in_test_files_end_in_test() {
|
|
// Who tests the tests? :-) (ref: http://www.xkcd.com/1163)
|
|
$dir = new PhpCodeFilterIterator(
|
|
new GalleryCodeFilterIterator(
|
|
new RecursiveIteratorIterator(
|
|
new RecursiveDirectoryIterator(DOCROOT))));
|
|
foreach ($dir as $file) {
|
|
$scan = 0;
|
|
if (basename(dirname($file)) == "tests") {
|
|
foreach (file($file) as $line) {
|
|
if (!substr($file, -9, 9) == "_Test.php") {
|
|
continue;
|
|
}
|
|
|
|
if (preg_match("/class.*extends.*Gallery_Unit_Test_Case/", $line)) {
|
|
$scan = 1;
|
|
} else if (preg_match("/class.*extends/", $line)) {
|
|
$scan = 0;
|
|
}
|
|
|
|
if ($scan) {
|
|
if (preg_match("/^\s*public\s+function/", $line)) {
|
|
$this->assert_true(
|
|
preg_match("/^\s*public\s+function (setup|teardown|.*_test)\(\) {/", $line),
|
|
"public functions must end in _test:\n$file\n$line\n");
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
public function no_extra_spaces_at_end_of_line_test() {
|
|
$dir = new GalleryCodeFilterIterator(
|
|
new RecursiveIteratorIterator(new RecursiveDirectoryIterator(DOCROOT)));
|
|
$errors = "";
|
|
foreach ($dir as $file) {
|
|
if (preg_match("/\.(php|css|html|js)$/", $file)) {
|
|
foreach (file($file) as $line_num => $line) {
|
|
if ((substr($line, -2) == " \n") || (substr($line, -1) == " ")) {
|
|
$errors .= "$file at line " . ($line_num + 1) . "\n";
|
|
}
|
|
}
|
|
}
|
|
}
|
|
$this->assert_true(empty($errors), "Extra spaces at end of line found at:\n$errors");
|
|
}
|
|
}
|