* @param string name the name of the var to search
* @param mixed value the variable to return
* @param int search constant defining where to look
+ * @param int typecast force variable to be cast to given type (please
+ * use SQ_TYPE_XXX constants or set to FALSE (default)
+ * to leave variable type unmolested)
* @return bool whether variable is found.
*/
function sqgetGlobalVar($name, &$value, $search = SQ_INORDER, $default = NULL, $typecast = false) {
}
if ($result && $typecast) {
switch ($typecast) {
- case 'int': $value = (int) $value; break;
- case 'bool': $value = (bool) $value; break;
+ case SQ_TYPE_INT: $value = (int) $value; break;
+ case SQ_TYPE_STRING: $value = (string) $value; break;
+ case SQ_TYPE_BOOL: $value = (bool) $value; break;
default: break;
}
- } else if (!is_null($default)) {
+ } else if (!$result && !is_null($default)) {
$value = $default;
}
return $result;
/**
* Deletes an existing session, more advanced than the standard PHP
* session_destroy(), it explicitly deletes the cookies and global vars.
+ *
+ * WARNING: Older PHP versions have some issues with session management.
+ * See http://bugs.php.net/11643 (warning, spammed bug tracker) and
+ * http://bugs.php.net/13834. SID constant is not destroyed in PHP 4.1.2,
+ * 4.2.3 and maybe other versions. If you restart session after session
+ * is destroyed, affected PHP versions produce PHP notice. Bug should
+ * be fixed only in 4.3.0
*/
function sqsession_destroy() {
if ($sDomain) {
$sHeader .= "; Domain=$sDomain";
}
+ // TODO: IE for Mac (5.2) thinks that semicolon is part of cookie domain
if ($bSecure) {
$sHeader .= "; Secure";
}
}
+/**
+ * Find files and/or directories in a given directory optionally
+ * limited to only those with the given file extension. If the
+ * directory is not found or cannot be opened, no error is generated;
+ * only an empty file list is returned.
+FIXME: do we WANT to throw an error or a notice or... or return FALSE?
+ *
+ * @param string $directory_path The path (relative or absolute)
+ * to the desired directory.
+ * @param string $extension The file extension filter (optional;
+ * default is to return all files (dirs).
+ * @param boolean $return_filenames_only When TRUE, only file/dir names
+ * are returned, otherwise the
+ * $directory_path string is
+ * prepended to each file/dir in
+ * the returned list (optional;
+ * default is filename/dirname only)
+ * @param boolean $include_directories When TRUE, directories are
+ * included (optional; default
+ * DO include directories).
+ * @param boolean $directories_only When TRUE, ONLY directories
+ * are included (optional; default
+ * is to include files too).
+ * @param boolean $separate_files_and_directories When TRUE, files and
+ * directories are returned
+ * in separate lists, so
+ * the return value is
+ * formatted as a two-element
+ * array with the two keys
+ * "FILES" and "DIRECTORIES",
+ * where corresponding values
+ * are lists of either all
+ * files or all directories
+ * (optional; default do not
+ * split up return array).
+ *
+ *
+ * @return array The requested file/directory list(s).
+ *
+ * @since 1.5.2
+ *
+ */
+function list_files($directory_path, $extension='', $return_filenames_only=TRUE,
+ $include_directories=TRUE, $directories_only=FALSE,
+ $separate_files_and_directories=FALSE) {
+
+ $files = array();
+ $directories = array();
+
+//FIXME: do we want to place security restrictions here like only allowing
+// directories under SM_PATH?
+ // validate given directory
+ //
+ if (empty($directory_path)
+ || !is_dir($directory_path)
+ || !($DIR = opendir($directory_path))) {
+ return $files;
+ }
+
+
+ if (!empty($extension)) $extension = '.' . trim($extension, '.');
+ $directory_path = rtrim($directory_path, '/');
+
+
+ // parse through the files
+ //
+ while (($file = readdir($DIR)) !== false) {
+
+ if ($file == '.' || $file == '..') continue;
+
+ if (!empty($extension)
+ && strrpos($file, $extension) !== (strlen($file) - strlen($extension)))
+ continue;
+
+ // only use is_dir() if we really need to (be as efficient as possible)
+ //
+ $is_dir = FALSE;
+ if (!$include_directories || $directories_only
+ || $separate_files_and_directories) {
+ if (is_dir($directory_path . '/' . $file)) {
+ if (!$include_directories) continue;
+ $is_dir = TRUE;
+ $directories[] = ($return_filenames_only
+ ? $file
+ : $directory_path . '/' . $file);
+ }
+ if ($directories_only) continue;
+ }
+
+ if (!$separate_files_and_directories
+ || ($separate_files_and_directories && !$is_dir)) {
+ $files[] = ($return_filenames_only
+ ? $file
+ : $directory_path . '/' . $file);
+ }
+
+ }
+ closedir($DIR);
+
+
+ if ($directories_only) return $directories;
+ if ($separate_files_and_directories) return array('FILES' => $files,
+ 'DIRECTORIES' => $directories);
+ return $files;
+
+}
+
+
+/**
+ * Print variable
+ *
+ * sm_print_r($some_variable, [$some_other_variable [, ...]]);
+ *
+ * Debugging function - does the same as print_r, but makes sure special
+ * characters are converted to htmlentities first. This will allow
+ * values like <some@email.address> to be displayed.
+ * The output is wrapped in <<pre>> and <</pre>> tags.
+ * Since 1.4.2 accepts unlimited number of arguments.
+ * @since 1.4.1
+ * @return void
+ */
+function sm_print_r() {
+ ob_start(); // Buffer output
+ foreach(func_get_args() as $var) {
+ print_r($var);
+ echo "\n";
+ // php has get_class_methods function that can print class methods
+ if (is_object($var)) {
+ // get class methods if $var is object
+ $aMethods=get_class_methods(get_class($var));
+ // make sure that $aMethods is array and array is not empty
+ if (is_array($aMethods) && $aMethods!=array()) {
+ echo "Object methods:\n";
+ foreach($aMethods as $method) {
+ echo '* ' . $method . "\n";
+ }
+ }
+ echo "\n";
+ }
+ }
+ $buffer = ob_get_contents(); // Grab the print_r output
+ ob_end_clean(); // Silently discard the output & stop buffering
+ print '<div align="left"><pre>';
+ print htmlentities($buffer);
+ print '</pre></div>';
+}
+
+
projects / squirrelmail.git / blobdiff