- 
-
- util.php is a collection of useful functions and snippets - that you need or could use every day. It's implemented as a class with static methods, to avoid conflicts with your - existing code-base. Just drop it in and start using it immediately. -
- -- Included are 60+ functions that provide you with the ability to do common tasks much easier and more efficiently, - without having to find that one comment on php.net where you know its been done already. Access superglobals - without checking to see if certain indexes are set first and pass default values, use a nicely formatted var dump, - validate emails, generate random strings, flatten an array, pull a single column out of a multidimensional array - and much more. -
- -- Although it's implemented as one giant class, util.php has extensive documentation and a full suite of unit tests - to avoid breaking backwards-compatibility unintentionally. -
- -- The project is hosted on GitHub. - You can report bugs and discuss features on the - issues page, - or send tweets to @brandonwamboldt. -
- -
- Stable Version (1.1.0)
- Unstable Version (master)
-
- Simply drop util.php in any project and call include 'util.php'; in your project.
- You can then access the Util class.
-
- Add the following dependency to your composer.json: - -
"brandonwamboldt/utilphp": "1.1.*"- - When used with composer, the class is namespaced (
\utilphp\util) instead of
- just util.
-
-
-
- var_dump
-
- util::var_dump(mixed $var[, bool $return = FALSE])
-
-
- Nicely prints out the contents of a passed variable. Booleans are properly displayed as 'true' or 'false', - null values are shown as 'NULL', variable types are displayed, and arrays and objects are displayed as a - collapsible tree powered by JavaScript. -
- -Usage:
- -util::var_dump($var);- -
-
- array_first
-
- util::array_first(array $array)
-
-
- Retrieve the first value from an array. Can be run on function callbacks, and it will not modify the pointer - of the source array unlike most other methods of doing this. -
- -Usage:
- -util::array_first( ['a', 'b', 'c'] );-
=> Returns 'a'
- array_first_key
-
- util::array_first_key(array $array)
-
-
- Retrieve the first key from an array. Can be run on function callbacks, and it will not modify the pointer of - the source array unlike most other methods of doing this. -
- -Usage:
- -util::array_first_key( $users );-
=> Returns 'brandon'
- array_flatten
-
- util::array_flatten(array $array[, bool $preserve_keys = TRUE])
-
-
Flattens a multi-dimensional array into a one dimensional array
- -Usage:
- -util::array_flatten( [ 'a', 'b', [ 'c', 'd', 'e', [ 'f', 'g', [ [ [ [ 'h', 'i', 'j' ] ] ] ] ] ] ] ); -=> Returns [ 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j' ]-
- array_get
-
- util::array_get($var[, mixed $default = NULL])
-
-
Retrieve a value from an array, or return a given default if the index isn't set
- -Usage:
- -util::array_get($_POST['action'], 'index'); -=> If $_POST['action'] is set, returns its value, otherwise returns 'index' -util::array_get($_POST['action']['do'], 'index'); -=> Returns the value of $_POST['action']['do'] or 'index'-
- array_last
-
- util::array_last(array $array)
-
-
- Retrieve the last value from an array. Can be run on function callbacks, and it will not modify the pointer - of the source array unlike most other methods of doing this. -
- -Usage:
- -util::array_last( [ 'a', 'b', 'c'] ); -=> Returns 'c'-
- array_last_key
-
- util::array_last_key(array $array)
-
-
- Retrieve the last key from an array. Can be run on function callbacks, and it will not modify the pointer of - the source array unlike most other methods of doing this. -
- -Usage:
- -util::array_last_key( $users ); -=> Returns 'zane'-
- array_map_deep
-
- util::array_map_deep(array $array, callable $callback[, bool $on_nonscalar = FALSE])
-
-
- Returns an array containing all the elements of $array after applying the callback function to each one recursively. - Particularly useful for avoiding errors when calling functions that only accept scalar values on an array that could - contain nested arrays, such as $_GET or $_POST. -
- -Usage:
- -util::array_map_deep($_POST, 'htmlentities'); -=> Recursively escapes each scalar value in $_POST -util::array_map_deep($_POST, 'htmlentities', TRUE); -=> Recursively escapes each value in $_POST regardless of its type-
- array_pluck
-
- util::array_pluck(array $array, string $field[, bool $preserve_keys, bool $remove_nomatches])
-
-
- Replaces each value in an array with the specified field of the array or object that used to be the value. Very - useful when you have an array of objects or arrays from a database, and you only want one specific field. For - example, you want an array of emails from an array of users. -
- -Usage:
- -util::array_pluck([['val' => 1], ['val' => 2], ['val' => 3]], 'val'); -=> Returns [1, 2, 3] -util::array_pluck($users, 'email'); -=> Returns an array of email addresses for each user-
- array_search_deep
-
- util::array_search_deep(array $array, mixed $search[, string $field = FALSE])
-
-
- Allows you to search for a value in an array of arrays or an array of objects, and return the key of the value - that matches the search criteria. If $field is unspecified, the entire array/object is searched. -
- -Usage:
- -util::array_search_deep($_POST, 'delete_post'); -=> Might return 'do' if $_POST['do']['action'] = 'delete_post' -util::array_search_deep($users, 'rogue_coder', 'username'); -=> Might return 5 if $users[5]->username = 'rogue_coder'-
- array_clean
-
- util::array_clean(array $array)
-
-
- Remove all null/empty/false values from the given array. -
- -Usage:
- -util::array_clean( array( 'a', 'b', '', null, false, 0) );-
=> Returns array('a', 'b');
- add_query_arg
-
- util::add_query_arg()
-
-
Adds one ore more query args to the query string of the current URL or a given URL
- -Usage:
- -util::add_query_arg( 'user', '5', '/admin/users?action=edit' ); -=> Returns '/admin/users?action=edit&user=5' -util::add_query_arg( [ 'user' => 5, 'action' => 'edit' ], '/admin/users' ); -=> Returns '/admin/users?user=5&action=edit'-
- get_current_url
-
- util::get_current_url()
-
-
Returns the current URL with hostname
- -Usage:
- -util::get_current_url(); -=> Returns 'http://brandonwamboldt.ca/utilphp/'-
- is_https
-
- util::is_https()
-
-
Returns true if the current page is being loaded over https, false if it isn't
- -Usage:
- -util::is_https(); -=> Returns false-
- http_build_url
-
- util::http_build_url([mixed $url[, mixed $parts[, int $flags = HTTP_URL_REPLACE[, array &amo;$new_url]]]])
-
-
- Pure PHP implementation/polyfill for http_build_url - which requires pecl_http to be installed. -
- -Usage:
- -echo util::http_build_url("http://user@www.example.com/pub/index.php?a=b#files",
- array(
- "scheme" => "ftp",
- "host" => "ftp.example.com",
- "path" => "files/current/",
- "query" => "a=c"
- ),
- HTTP_URL_STRIP_AUTH | HTTP_URL_JOIN_PATH | HTTP_URL_JOIN_QUERY | HTTP_URL_STRIP_FRAGMENT
-);
-
- The above example will output:
- -ftp://ftp.example.com/pub/files/current/?a=c-
- is_https
-
- util::is_https()
-
-
Returns true if the current page is being loaded over https, false if it isn't
- -Usage:
- -util::is_https(); -=> Returns false-
- remove_query_arg
-
- util::remove_query_arg( array|string $query_args[, string $url])
-
-
Removes one ore more query args from the query string of the current URL or a given URL
- -Usage:
- -util::remove_query_arg( 'action', '/admin/users?action=edit&user=5' ); -=> Returns '/admin/users?user=5' -util::remove_query_arg( [ 'user', 'action'], '/admin/users?action=edit&user=5' ); -=> Returns '/admin/users'-
- slugify
-
- util::slugify(string $string[, string $separator = "-", bool $css_mode = FALSE])
-
-
- Generate a string safe for use in URLs from any given string. Converts any accent characters - to their equivalent normal characters and converts any other non-alphanumeric characters to - dashes, then converts any sequence of two or more dashes to a single dash. This function - generates slugs safe for use as URLs, and if you pass TRUE as the second parameter, it will - create strings safe for use as CSS classes or IDs. -
- -Usage:
- -util::slugify('This is a random --string with an Ãccent');
-=> Returns 'this-is-a-random-string-with-an-accent'
-util::slugify('Another String', '.');
-=> Returns 'another.string'
-
- htmlentities
-
- util::htmlentities(string $string[, bool $preserve_encoded_entities = FALSE])
-
-
- Executes htmlentities with ENT_QUOTES set by default. However, if you pass TRUE as - the second parameter, it will not re-encode entities that are already encoded. -
- -Usage:
- -util::htmlentities('this string < this string', TRUE);
-=> Returns 'this string < this string'
-
- htmlspecialchars
-
- util::htmlspecialchars(string $string[, bool $preserve_encoded_entities = FALSE])
-
-
- Executes htmlspecialchars with ENT_QUOTES set by default. However, if you pass TRUE as - the second parameter, it will not re-encode entities that are already encoded. -
- -Usage:
- -util::htmlspecialchars('this string < this string', TRUE);
-=> Returns 'this string < this string'
-
- linkify
-
- util::linkify(string $text)
-
-
Find's any URLs in the specified text and wraps them with HTML anchor tags
- -Usage:
- -util::linkify('this string has a link to www.google.com');
-=> Returns 'this string has a link to <a href="http://wwww.google.com/">www.google.com</a>'
-
- match_string
-
- util::match_string(string $pattern, string $string[, bool $caseSensitive = true])
-
-
- Check if a string matches a given pattern. You can use '*' as a wildcard character. -
- -Usage:
- -util::match_string("test/*", "test/my/test");
-=> Returns true
-util::match_string("test/", "test/my/test");
-=> Returns false
-
- random_string
-
- util::random_string(int $length[, bool $human_friendly = TRUE, bool $include_symbols = FALSE, bool $no_duplicate_chars = FALSE])
-
-
- Generates a random string of the specified length. Human friendly mode - will exclude characters that can be confused with other characters, such - as 0 (zero) and O (capital o), 1 (one) and l (lowercase L). -
- -Usage:
- -util::random_string(8); -=> Returns 'a6BiF4UW'-
- number_to_word
-
- util::number_to_word(int|float $number)
-
-
Converts a number into its text equivalent. For example, 56 becomes fifty-six.
- -util::number_to_word(512.5); -=> Returns 'five hundred and twelve point five'-
- ordinal
-
- util::ordinal(int $number)
-
-
Returns the ordinal version of a number (appends th, st, nd, rd)
- -Usage:
- -util::ordinal(22); -=> Returns '22nd'-
- remove_accents
-
- util::remove_accents(string $string)
-
-
Converts all accent characters to their ASCII equivalents
- -Usage:
- -util::remove_accents('Àccent');
-=> Returns 'Accent'
-
- secure_random_string
-
- util::secure_random_string(int $length)
-
-
Generate a random string of characters. Will attempt to use a secure source (openssl).
- -Usage:
- -util::secure_random_string(16); -=> Returns '5bB1RJH0cQhNjviT'-
- seems_utf8
-
- util::seems_utf8(string $string)
-
-
Checks to see if a given string is UTF-8 encoded/safe
- -Usage:
- -util::seems_utf8('This is some random string user input');
-=> Returns true
-
- safe_truncate
-
- util::safe_truncate(string $string, int $length[, string $append = '...'])
-
-
Truncate a string to a specified length without cutting a word off
- -Usage:
- -util::safe_truncate('The quick brown fox jumps over the lazy dog', 24);
-=> Returns 'The quick brown fox...'
-
- size_format
-
- util::size_format(int $bytes[, int $decimals = 0])
-
-
Formats an integer as a human friendly size string, such as 4 KiB.
- -Usage:
- -util::size_format( 25151251, 2 ); -=> Returns '23.99 MiB'-
- str_to_bool
-
- util::str_to_bool(string $string)
-
-
Converts a string to boolean, looking for yes/no words like 'yes', 'no', 'true', 'false', 'y', 'n', etc
- -Usage:
- -util::str_to_bool('yes');
-=> Returns true
-
- zero_pad
-
- util::zero_pad(int $number, int $length)
-
-
Pads a given number with zeroes on the left
- -Usage:
- -util::zero_pad(341, 8); -=> Returns '00000341'-
- strip_space
-
- util::strip_space(string $string)
-
-
Strip all withspace from the given string
- -Usage:
- -util::strip_space(' The quick brown fox jumps over the lazy dog ');
-=> Returns 'Thequickbrownfoxjumpsoverthelazydog'
-
- sanitize_string
-
- util::sanitize_string(string $string)
-
-
- Sanitize a string by performing the following operation : -
Usage:
- -util::sanitize_string(' Benoit! à New-York? j’ai perçu 1 % : Qu’as-tu "gagné" chez M. V. Noël? Dix francs.');
-=> Returns 'benoitanewyorkjaipercu1quastugagnechezmvnoeldixfrancs'
-
- full_permissions
-
- util::full_permissions(string $file)
-
-
Returns the file permissions as a nice string, like -rw-r--r--
- -Usage:
- -util::full_permissions('/etc/passwd');
-=> Returns '-rw-r--r--'
-
- rmdir
-
- util::rmdir(string $dir[, bool $traverseSymlinks = false])
-
-
Recursively deletes a directories (including all contents).
- -Usage:
- -util::rmdir('/tmp/working/dir');
-=> Returns true
-
- is_serialized
-
- util::is_serialized(mixed $data)
-
-
Checks to see if a given variable is a seralized data structure
- -Usage:
- -util::is_serialized( 'a:0:{}' );
-=> Returns true
-
- maybe_serialize
-
- util::maybe_serialize(mixed $data)
-
-
Serialize data, if needed to store in plaintext (Arrays or objects)
- -Usage:
- -util::maybe_serialize( 5 );
-=> Returns 5
-util::maybe_serialize( array() );
-=> Returns 'a:0:{}'
-
- maybe_unserialize
-
- util::maybe_unserialize(mixed $data)
-
-
Unserialize data, if it's a serialized string
- -Usage:
- -util::maybe_unserialize(5);
-=> Returns 5
-util::maybe_unserialize("a:0:{}");
-=> Returns array()
-
- fix_broken_serialization
-
- util::fix_broken_serialization(mixed $data)
-
-
- Attempt to fix a broken serialization string (e.g. where string offsets are incorrect). Can fix - errors that frequently occur with mismatched character sets or higher-than-ASCII characters. -
- -Usage:
- -util::fix_broken_serialization('a:1:{s:4:"test";s:4:"abc";}');
-=> Returns 'a:1:{s:4:"test";s:3:"abc";}'
-
- force_download
-
- util::force_download(string $filename, string $content = FALSE)
-
-
- Transmit headers that force a browser to display the download file dialog. Cross - browser compatible. Only fires if headers have not already been sent. -
- -Usage:
- -util::force_download( 'export.csv', file_get_contents( 'securefile.csv' ) ); -=> The user will be prompted to download the file-
- get_client_ip
-
- util::get_client_ip(bool $trust_proxy_headers = FALSE)
-
-
- Returns the IP address of the client. Only enable $trust_proxy_headers if your server is behind a proxy - that sets the HTTP_CLIENT_IP and HTTP_X_FORWARDED_FOR headers. -
- -Usage:
- -util::get_client_ip(); -=> Returns '12.123.12.100'-
- get_gravatar
-
- util::get_gravatar(string $email, int $size = 32)
-
-
Return the URL to a user's gravatar
- -Usage:
- -util::get_gravatar('brandon.wamboldt@gmail.com');
-=> Returns 'http://www.gravatar.com/avatar/46679faeb6780ecb1ea57527fdc66eb3?s=32'
-
- human_time_diff
-
- util::human_time_diff(int $from, int $to = '', int $as_text = FALSE, string $suffix = ' ago')
-
-
Converts a unix timestamp to a relative time string, such as "3 days ago" or "2 weeks ago"
- -Usage:
- -util::human_time_diff(time() - 7400); -=> Returns '2 hours ago' -util::human_time_diff(time() - 7400, '', TRUE); -=> Returns 'two hours ago'-
- nocache_headers
-
- util::nocache_headers(mixed $data)
-
-
Sets the headers to prevent caching for the different browsers
- -- Different browsers support different nocache headers, so several headers must be sent - so that all of them get the point that no caching should occur -
- -Usage:
- -util::nocache_headers();-
- utf8_headers
-
- util::utf8_headers(mixed $content_type = 'text/html')
-
-
Transmit UTF-8 content headers if the headers haven't already been sent
- -Usage:
- -util::utf8_headers();-
- validate_email
-
- util::validate_email(string $possible_email)
-
-
Validate an email address
- -Usage:
- -util::validate_email( 'brandon.wamboldt@gmail.com' ); -=> Returns true -util::validate_email( 'not an email' ); -=> Returns false-
- SECONDS_IN_A_MINUTE
-
- util::SECONDS_IN_A_MINUTE
-
-
The number of seconds in a minute, useful for making code more verbose
-
- SECONDS_IN_AN_HOUR
-
- util::SECONDS_IN_AN_HOUR
-
-
The number of seconds in an hour, useful for making code more verbose
-
- SECONDS_IN_A_DAY
-
- util::SECONDS_IN_A_DAY
-
-
The number of seconds in a day, useful for making code more verbose
-
- SECONDS_IN_A_WEEK
-
- util::SECONDS_IN_A_WEEK
-
-
The number of seconds in a week (7 days), useful for making code more verbose
-
- SECONDS_IN_A_MONTH
-
- util::SECONDS_IN_A_MONTH
-
-
The number of seconds in a month (30 days), useful for making code more verbose
-
- SECONDS_IN_A_YEAR
-
- util::SECONDS_IN_A_YEAR
-
-
The number of seconds in a year (365 days), useful for making code more verbose
-
- 1.1.0
-
- This release introduces a deprecation notice for slugify(), please update your code.
-
- - Added a cryptographically secure random string function secure_random_string. Thanks to @abhimanyusharma003 via Pull Request #53
- - Added limit_characters and limit_words functions. Thanks to @abhimanyusharma003 via Pull Request #55
- - Added rmdir method to recursively delete a directory. Thanks to @ARACOOOL via Pull Request #56
- - Added set_executable, set_readable, set_writable, directory_size, directory_contents and get_user_dir functions. Thanks to @sergserg via Pull Request #70
- - Changed parameter ordering for slugify, $css_mode is now the third argument. For backwards compatibility, the old order will still work but it will generate an E_USER_DEPRECATED warning. Thanks to @abhimanyusharma003 via Pull Request #71
- - Added match_string method. Thanks to @abhimanyusharma003 via Pull Request #72
- - Renamed internal methods (protected ones) for PSR-2 compliance
- - General performance improvements, code quality improvements, and increased unit test coverage (special thanks to @hopeseekr for getting us near 100% coverage)
-
- 1.0.7
- - Added fix_broken_serialization to fix broken serialized strings (Thanks to @hopeseekr via Pull Request #48)
- - Fixed get_current_url appending port 80 or 443 when not needed (Thanks to @scottchiefbaker via Pull Request #49)
- - var_dump can now handle recursive data structures without crashing
- - var_dump code was minified and cleaned up
- - array_flatten was optimized (thanks to @hopeseekr via Pull Request #47)
- - remove_accents was completely rewritten and is now ~4x faster
-
- 1.0.6
- - Added start_with function
- - Added ends_with function
- - Added str_contains function
- - Added str_icontains function
- - Added get_file_ext function
- - Fixing permissions on the files & directories
- - Fixing a bug with the include path of util.php
-
- 1.0.5
- - Issue #29 Fixed error in var_dump if mbstring extension wasn't present
- - Adding Composer support
- - Updating license from GPL to MIT
- - Adding Changelog to project
- - Bumping minimum version to PHP 5.3.3
-
- 1.0.4
- - Issue #22 Removed all superglobal *_get functions, you can use the modified array_get now
- - Issue #22 Modifed the behaviour of array_get, see documentation
- - Pull Request #21 Added multibyte support to html* functions
- - Issue #9 Removed the str_to_utf8 function
- - Issue #3 Removed the absint function
- - Removed declare() from util.php to avoid errors
- - Updated PHPUnit tests to use PHPUnit 3.6
-
- 1.0.3
- - Issue #16 Improved performance of slugify
- - Issue #14 Modified the regex for seems_utf8 to be more accurate
- - Issue #13 Changed validate_email to be wrapper for filter_var
- - Added 'ok' to the list of yes words for str_to_bool
- - str_to_bool matches no followed by any number of 'o's
-
- 1.0.2
- - Issue #12 get_current_url now includes the port and user/password if required
- - Issue #11 human_time_diff now uses the DateTime functions
- - Issue #10 is_https no longer checks the port as well
-
- 1.0.1
- - Issue #7 Added the $trust_proxy_headers parameter to get_client_ip
- - Issue #6 Removed is_isset as the function did not work as intended
- - Issue #6 Removed is_empty as it is redundant, use ! with function calls instead
- - Fixed a bug with get_gravatar
-
- 1.0.0
- Initial release of util.php.
-
string(3) "var"'; - - // Ensure the proper output is returned - $this->assertEquals($expect, Util::var_dump($input, true)); - - // Ensure the proper output is actually outputted - $this->expectOutputString($expect); - util::var_dump($input); - - // Ensure we avoid infinite recursion on recursive arrays - $a = array('a' => 'value a', 'b' => 'value b'); - $b = array('test' => &$a); - $c = array('a' => &$a, 'b' => &$b); - $a['c'] = &$c; - $b['c'] = &$c; - $this->assertContains('*RECURSION DETECTED*', Util::var_dump($c, true)); - - // Ensure we avoid infinite recursion on recursive objects - $a = (object) array('a' => 'value a', 'b' => 'value b'); - $b = (object) array('test' => &$a); - $c = (object) array('a' => &$a, 'b' => &$b); - $a->c = &$c; - $b->c = &$c; - $this->assertContains('*RECURSION DETECTED*', Util::var_dump($c, true)); - - // Test class scoping. - $experiment = new VarDumpExperiment(); - $actual = util::var_dump($experiment, true); - - $snippet = substr($actual, strrpos($actual, 'display:inline')); - $this->assertContains('"public"', $snippet); - $this->assertContains('"protected:protected"', $snippet); - $this->assertContains('"private:VarDumpExperiment:private"', $actual); - } - - public function test_linkify() - { - $input = 'great websites: http://www.google.com?param=test and http://yahoo.com/a/nested/folder'; - $expect = 'great websites: http://www.google.com?param=test and http://yahoo.com/a/nested/folder'; - $this->assertEquals($expect, Util::linkify($input)); - - $this->assertEquals($expect, util::linkify($expect), 'linkify() tried to double linkify an href.'); - } - - public function test_start_with() - { - $this->assertTrue(Util::starts_with('start a string', 'start a')); - $this->assertFalse(Util::starts_with('start a string', 'string')); - } - - public function test_end_with() - { - $this->assertTrue(Util::ends_with('start a string', 'a string')); - $this->assertFalse(Util::ends_with('start a string', 'start')); - } - - public function test_contains() - { - $this->assertTrue(Util::str_contains('start a string', 'a string')); - $this->assertFalse(Util::str_contains('start a string', 'Start')); - } - - public function test_iContains() - { - $this->assertTrue(Util::str_icontains('start a string', 'a string')); - $this->assertTrue(Util::str_icontains('start a string', 'Start')); - } - - public function test_get_file_ext() - { - $input = 'a_pdf_fil.pdf'; - $expect = 'pdf'; - $this->assertEquals($expect, Util::get_file_ext($input)); - } - - public function test_rmdir() - { - $dirname = dirname(__FILE__); - - // Test deleting a non-existant directory - $this->assertFalse(file_exists($dirname . '/test1')); - $this->assertTrue(util::rmdir($dirname . '/test1')); - - // Test deleting an empty directory - $dir = $dirname . '/test2'; - mkdir($dir); - - $this->assertTrue(is_dir($dir)); - - if (is_dir($dir)) { - util::rmdir($dir); - $this->assertFalse(is_dir($dir)); - } - - // Test deleting a non-empty directory - $dir = $dirname . '/test3'; - $file = $dirname . '/test3/test.txt'; - mkdir($dir); - touch($file); - - $this->assertTrue(is_dir($dir)); - $this->assertTrue(is_file($file)); - - if (is_dir($dir)) { - util::rmdir($dir); - $this->assertFalse(is_dir($dir)); - $this->assertFalse(is_file($file)); - } - - // Test deleting a non-directory path - $file = $dirname . '/test4.txt'; - touch($file); - - try { - $str = util::rmdir($file); - $this->assertTrue(false); - } catch (\Exception $e) { - $this->assertTrue(true); - } - - unlink($file); - - // Test deleting a nested directory - $dir1 = $dirname . '/test5'; - $dir2 = $dirname . '/test5/nested_dir'; - $file1 = $dir1 . '/file1.txt'; - $file2 = $dir2 . '/file2.txt'; - mkdir($dir1); - mkdir($dir2); - touch($file1); - touch($file2); - - $this->assertTrue(is_dir($dir1)); - $this->assertTrue(is_dir($dir2)); - $this->assertTrue(is_file($file1)); - $this->assertTrue(is_file($file2)); - - if (is_dir($dir1)) { - util::rmdir($dir1); - $this->assertFalse(is_dir($dir1)); - $this->assertFalse(is_dir($dir2)); - $this->assertFalse(is_file($file1)); - $this->assertFalse(is_file($file2)); - } - - // Test symlink traversal. - $dir = $dirname . '/test6'; - $nestedDir = "$dir/nested"; - $symlink = "$dir/nested-symlink"; - - mkdir($dir); - mkdir($nestedDir); - - $symlinkStatus = symlink($nestedDir, $symlink); - $this->assertTrue($symlinkStatus, 'The test system does not support making symlinks.'); - - if (!$symlink) { - return; - } - - $this->assertTrue(util::rmdir($symlink, true), 'Could not delete a symlinked directory.'); - $this->assertFalse(file_exists($symlink), 'Could not delete a symlinked directory.'); - util::rmdir($dir, true); - $this->assertFalse(is_dir($dir), 'Could not delete a directory with a symlinked directory inside of it.'); - } - - public function test_get_current_url() - { - $expected = 'http://test.dev/test.php?foo=bar'; - $expectedAuth = 'http://admin:123@test.dev/test.php?foo=bar'; - $expectedPort = 'http://test.dev:443/test.php?foo=bar'; - $expectedPort2 = 'https://test.dev:80/test.php?foo=bar'; - $expectedSSL = 'https://test.dev/test.php?foo=bar'; - - $_SERVER['HTTP_HOST'] = 'test.dev'; - $_SERVER['SERVER_PORT'] = 80; - $_SERVER['REQUEST_URI'] = '/test.php?foo=bar'; - $_SERVER['QUERY_STRING'] = 'foo=bar'; - $_SERVER['PHP_SELF'] = '/test.php'; - - // Test regular. - $this->assertEquals($expected, util::get_current_url()); - - // Test server auth. - $_SERVER['PHP_AUTH_USER'] = 'admin'; - $_SERVER['PHP_AUTH_PW'] = '123'; - $this->assertEquals($expectedAuth, util::get_current_url()); - unset($_SERVER['PHP_AUTH_USER']); - unset($_SERVER['PHP_AUTH_PW']); - - // Test port. - $_SERVER['SERVER_PORT'] = 443; - $this->assertEquals($expectedPort, util::get_current_url()); - - // Test SSL. - $_SERVER['HTTPS'] = 'on'; - $this->assertEquals($expectedSSL, util::get_current_url()); - $_SERVER['SERVER_PORT'] = 80; - $this->assertEquals($expectedPort2, util::get_current_url()); - unset($_SERVER['HTTPS']); - - // Test no $_SERVER['REQUEST_URI'] (e.g., MS IIS). - unset($_SERVER['REQUEST_URI']); - $this->assertEquals($expected, util::get_current_url()); - } - - public function test_set_writable() - { - if (strncasecmp(PHP_OS, 'WIN', 3) === 0) { - $this->markTestSkipped('This functionality is not working on Windows.'); - } - - if (posix_geteuid() === 0) { - $this->markTestSkipped('These tests don\'t work when run as root'); - } - - $this->assertFalse(util::set_writable('/no/such/file')); - - // Create a file to test with - $dirname = dirname(__FILE__); - $file = $dirname . '/test7'; - touch($file); - chmod($file, 0644); - - // The file is owned by us so it should be writable - $this->assertTrue(is_writable($file)); - $this->assertEquals('-rw-r--r--', util::full_permissions($file)); - - // Toggle writable bit off for us - util::set_writable($file, false); - clearstatcache(); - $this->assertFalse(is_writable($file)); - $this->assertEquals('-r--r--r--', util::full_permissions($file)); - - // Toggle writable bit back on for us - util::set_writable($file, true); - clearstatcache(); - $this->assertTrue(is_writable($file)); - $this->assertEquals('-rw-r--r--', util::full_permissions($file)); - - unlink($file); - } - - public function test_set_readable() - { - if (strncasecmp(PHP_OS, 'WIN', 3) === 0) { - $this->markTestSkipped('This functionality is not working on Windows.'); - } - - if (posix_geteuid() === 0) { - $this->markTestSkipped('These tests don\'t work when run as root'); - } - - $this->assertFalse(util::set_readable('/no/such/file')); - - $dirname = dirname(__FILE__); - $file = $dirname . '/test8'; - touch($file); - - $this->assertTrue(is_readable($file)); - - util::set_readable($file, false); - clearstatcache(); - $this->assertFalse(is_readable($file)); - - util::set_readable($file, true); - clearstatcache(); - $this->assertTrue(is_readable($file)); - - unlink($file); - } - - public function test_set_executable() - { - if (strncasecmp(PHP_OS, 'WIN', 3) === 0) { - $this->markTestSkipped('This functionality is not working on Windows.'); - } - - if (posix_geteuid() === 0) { - $this->markTestSkipped('These tests don\'t work when run as root'); - } - - $this->assertFalse(util::set_executable('/no/such/file')); - - $dirname = dirname(__FILE__); - $file = $dirname . '/test9'; - touch($file); - - $this->assertFalse(is_executable($file)); - - util::set_executable($file, true); - clearstatcache(); - $this->assertTrue(is_executable($file)); - - util::set_executable($file, false); - clearstatcache(); - $this->assertFalse(is_executable($file)); - - unlink($file); - } - - public function test_directory_size() { - $dirname = dirname(__FILE__); - $dir = $dirname .'/dir1'; - mkdir($dir); - $file1 = $dir .'/file1'; - file_put_contents($file1, '1234567890'); - $file2 = $dir .'/file2'; - file_put_contents($file2, range('a', 'z')); - $this->assertEquals(10 + 26, util::directory_size($dir)); - util::rmdir($dir); - } - - public function test_get_user_directory() { - // Test for OS Default. - $this->assertTrue(is_writable(util::get_user_directory())); - - $oldServer = $_SERVER; - unset($_SERVER); - // Test for UNIX. - $_SERVER['HOME'] = '/home/unknown'; - $this->assertEquals($_SERVER['HOME'], util::get_user_directory(), 'Could not get the user\'s home directory in UNIX.'); - unset($_SERVER); - - // Test for Windows. - $expected = 'X:\Users\ThisUser'; - $_SERVER['HOMEDRIVE'] = 'X:'; - $_SERVER['HOMEPATH'] = '\Users\ThisUser'; - $this->assertEquals($expected, util::get_user_directory(), 'Could not get the user\'s home directory in Windows.'); - - // In case the tests are not being run in isolation. - $_SERVER = $oldServer; - } - - public function test_directory_contents() { - $dirname = dirname(__FILE__); - $dir = $dirname . DIRECTORY_SEPARATOR .'dir1'; - mkdir($dir); - $file1 = $dir . DIRECTORY_SEPARATOR .'file1'; - touch($file1); - $this->assertEquals(array($file1), util::directory_contents($dir)); - util::rmdir($dir); - } -} diff --git a/f_config/DB.php b/f_config/DB.php index 706dbe68..dc460849 100644 --- a/f_config/DB.php +++ b/f_config/DB.php @@ -1,6 +1,6 @@ IsExist()) { diff --git a/f_config/DBS.php b/f_config/DBS.php index 225af9d7..8221551d 100644 --- a/f_config/DBS.php +++ b/f_config/DBS.php @@ -1,6 +1,6 @@ diff --git a/f_install/install1.php b/f_install/install1.php index 20331bca..5eed4764 100644 --- a/f_install/install1.php +++ b/f_install/install1.php @@ -1,5 +1,5 @@ diff --git a/f_install/install2Post.php b/f_install/install2Post.php index 92a789d2..01311af9 100644 --- a/f_install/install2Post.php +++ b/f_install/install2Post.php @@ -4,9 +4,9 @@ $id = $_POST['id']; $pw = $_POST['pw']; $pw = md5($pw.$pw); -require('_common.php'); +require_once('_common.php'); require(ROOT.W.F_FUNC.W.'class._Time.php'); -require(ROOT.W.F_CONFIG.W.DB.PHP); +require_once(ROOT.W.F_CONFIG.W.DB.PHP); // 시스템정보 1개 등록 $DB->InsertArray('SYSTEM', array( diff --git a/f_retrival/_common.php b/f_retrival/_common.php index 96d7af6e..9ed1eefa 100644 --- a/f_retrival/_common.php +++ b/f_retrival/_common.php @@ -2,9 +2,9 @@ if(!defined('ROOT')){ define('ROOT', '.'); } -require(ROOT.'/f_config/config.php'); -require(ROOT.W.F_CONFIG.W.APP.PHP); -require(ROOT.W.F_FUNC.W.FUNC.PHP); +require_once(ROOT.'/f_config/config.php'); +require_once(ROOT.W.F_CONFIG.W.APP.PHP); +require_once(ROOT.W.F_FUNC.W.FUNC.PHP); CustomHeader(); diff --git a/i_entrance/Frame.php b/i_entrance/Frame.php index 4a80fa1e..106f7193 100644 --- a/i_entrance/Frame.php +++ b/i_entrance/Frame.php @@ -1,7 +1,7 @@ Select('NOTICE', 'SYSTEM', "NO='1'"); $system = $DB->Get($rs); diff --git a/i_entrance/_common.php b/i_entrance/_common.php index 9df83991..f57670c9 100644 --- a/i_entrance/_common.php +++ b/i_entrance/_common.php @@ -3,9 +3,9 @@ if(!defined('ROOT')){ define('ROOT', '..'); } -require(ROOT.'/f_config/config.php'); -require(ROOT.W.F_CONFIG.W.APP.PHP); -require(ROOT.W.F_FUNC.W.FUNC.PHP); +require_once(ROOT.'/f_config/config.php'); +require_once(ROOT.W.F_CONFIG.W.APP.PHP); +require_once(ROOT.W.F_FUNC.W.FUNC.PHP); CustomHeader(); diff --git a/i_entrance/adminInc.php b/i_entrance/adminInc.php index 6492a9c8..9fb243e1 100644 --- a/i_entrance/adminInc.php +++ b/i_entrance/adminInc.php @@ -1,7 +1,7 @@ diff --git a/i_entrance/adminPost.php b/i_entrance/adminPost.php index 584c1510..15e0875e 100644 --- a/i_entrance/adminPost.php +++ b/i_entrance/adminPost.php @@ -5,12 +5,12 @@ // $_POST['server'] : 서버 인덱스 // $_POST['select'] : 0: 폐쇄, 1: 리셋, 2: 오픈 -require('_common.php'); +require_once('_common.php'); require(ROOT.W.E_LIB.W.'util.php'); -require(ROOT.W.E_LIB.W.'util.php'); -require(ROOT.W.F_FUNC.W.'class._JSON.php'); -require(ROOT.W.F_CONFIG.W.DB.PHP); -require(ROOT.W.F_CONFIG.W.SESSION.PHP); +require(ROOT.W.E_LIB.W.'plates.php'); +require_once(ROOT.W.F_FUNC.W.'class._JSON.php'); +require_once(ROOT.W.F_CONFIG.W.DB.PHP); +require_once(ROOT.W.F_CONFIG.W.SESSION.PHP); function escapeIPv4($ip){ return str_replace('.', '\\.', $ip); @@ -25,38 +25,61 @@ $select = util::array_get($_POST['select'], ''); $rs = $DB->Select('GRADE', 'MEMBER', "NO='{$SESSION->NoMember()}'"); $member = $DB->Get($rs); -$response['result'] = 'FAIL'; -if($member['GRADE'] < 6) { - $response['result'] = 'FAIL'; - $response['msg'] = '운영자 권한이 없습니다.'; -} else { - if($action == 0) { - $DB->Update('SYSTEM', "NOTICE='{$notice}'", 'NO=1'); - $response['result'] = 'SUCCESS'; - } elseif($action == 1) { - $serverDir = $_serverDirs[$server]; +function doServerModeSet($server, $select, &$reason){ + global $_serverDirs; + $serverDir = $_serverDirs[$server]; - if($select == 0) { - rename(realpath(dirname(__FILE__)).W.ROOT.W.$serverDir, realpath(dirname(__FILE__)).W.ROOT.W.$serverDir.'_close'); - rename(realpath(dirname(__FILE__)).W.ROOT.W.$serverDir.'_rest', realpath(dirname(__FILE__)).W.ROOT.W.$serverDir); - $response['result'] = 'SUCCESS'; - } elseif($select == 1) { - if(file_exists(realpath(dirname(__FILE__)).W.ROOT.W.$serverDir.'_close'.W.D_SETTING.W.SET.PHP)){ - @unlink(realpath(dirname(__FILE__)).W.ROOT.W.$serverDir.'_close'.W.D_SETTING.W.SET.PHP); - } - - $response['installURL'] = ROOT.W."{$serverDir}_close/install.php"; - $response['result'] = 'SUCCESS'; - } elseif($select == 2) { - rename(realpath(dirname(__FILE__)).W.ROOT.W.$serverDir, realpath(dirname(__FILE__)).W.ROOT.W.$serverDir."_rest"); - rename(realpath(dirname(__FILE__)).W.ROOT.W.$serverDir."_close", realpath(dirname(__FILE__)).W.ROOT.W.$serverDir); - $response['result'] = 'SUCCESS'; + if($select == 0) { + rename(realpath(dirname(__FILE__)).W.ROOT.W.$serverDir, realpath(dirname(__FILE__)).W.ROOT.W.$serverDir.'_close'); + rename(realpath(dirname(__FILE__)).W.ROOT.W.$serverDir.'_rest', realpath(dirname(__FILE__)).W.ROOT.W.$serverDir); + $response['result'] = 'SUCCESS'; + } elseif($select == 1) { + if(file_exists(realpath(dirname(__FILE__)).W.ROOT.W.$serverDir.'_close'.W.D_SETTING.W.SET.PHP)){ + @unlink(realpath(dirname(__FILE__)).W.ROOT.W.$serverDir.'_close'.W.D_SETTING.W.SET.PHP); } - } else { - $response['result'] = 'FAIL'; - $response['msg'] = '알 수 없는 명령입니다.'; + + $response['installURL'] = ROOT.W."{$serverDir}_close/install.php"; + $response['result'] = 'SUCCESS'; + } elseif($select == 2) { + rename(realpath(dirname(__FILE__)).W.ROOT.W.$serverDir, realpath(dirname(__FILE__)).W.ROOT.W.$serverDir."_rest"); + rename(realpath(dirname(__FILE__)).W.ROOT.W.$serverDir."_close", realpath(dirname(__FILE__)).W.ROOT.W.$serverDir); + $response['result'] = 'SUCCESS'; } } +function doAdminPost($member, $action, $notice, $server, $select){ + $response['result'] = 'FAIL'; + if($member['GRADE'] < 6) { + $response['result'] = 'FAIL'; + $response['msg'] = '운영자 권한이 없습니다.'; + return $response; + } + + if($action == 0) { + $DB->Update('SYSTEM', "NOTICE='{$notice}'", 'NO=1'); + $response['result'] = 'SUCCESS'; + return $response; + } + + if($action == 1) { + $reason = ''; + if(doServerModeSet($server, $select)){ + $response['result'] = 'SUCCESS'; + } + else{ + $response['msg'] = $reason; + } + + return $response; + } + + $response['result'] = 'FAIL'; + $response['msg'] = '알 수 없는 명령입니다.'; + return $response; + +} + +$response = doAdminPost($member, $action, $notice, $server, $select); + sleep(1); echo json_encode($response); diff --git a/i_entrance/donation/Frame.php b/i_entrance/donation/Frame.php index c2bcae56..f7d5a032 100644 --- a/i_entrance/donation/Frame.php +++ b/i_entrance/donation/Frame.php @@ -1,5 +1,5 @@