upload.php File Reference

Functions for handling file uploads / file attachments. More...

Go to the source code of this file.

Functions
	list_files ($item, $id)
	list files attached to an item
	delete_file ($item, $id, $filename)
	delete an attached file
	get_file ($item, $id, $filename)
	retrieve the contents of an attached file
	put_file ($item, $id, $filename, $contents)
	create an attachment
	upload ($smarty, $INPUT, $db)
	handle file uploads

---

Detailed Description

Functions for handling file uploads / file attachments.

It is possible to attach one or more files to an item. For example, you attach an online Table of Contents to a book. These functions manage the storage and retrieval of these files.

Definition in file upload.php.

---

Function Documentation

delete_file	(	$	item,
		$	id,
		$	filename
	)

delete an attached file

Parameters:

	$item	-- item type
	$id	-- item id
	$filename	-- the file name

Returns:

nothing

Definition at line 51 of file upload.php.

Referenced by del_item(), and do_delete_item().

                                            {
        global $upload_base_dir;

        $item = basename($item);
        $id = basename($id);
        $filename = basename($filename);

        if (!unlink("$upload_base_dir/$item/$id/$filename")) {
                user_error("could not delete file '$item/$id/$filename", 
                        E_USER_ERROR);  
        }
}

get_file	(	$	item,
		$	id,
		$	filename
	)

retrieve the contents of an attached file

Parameters:

	$item	-- item type
	$id	-- item id
	$filename	-- the file name

Returns:

contents of the file

Definition at line 72 of file upload.php.

Referenced by view_item().

                                         {
        global $upload_base_dir;

        $item = basename($item);
        $id = basename($id);
        $filename = basename($filename);

        return file_get_contents("$upload_base_dir/$item/$id/$filename");
}

list_files	(	$	item,
		$	id
	)

list files attached to an item

Parameters:

	$item	-- item type
	$id	-- item id

Returns:

an associative array that contains information about the attached files, as provided by the PHP function stat()

Definition at line 20 of file upload.php.

Referenced by do_delete_item(), edit_item(), show_collection(), and view_item().

                                {
        global $upload_base_dir;

        $item = basename($item);
        $id = basename($id);
        $dir = "$upload_base_dir/$item/$id"; 

        $answer = array();

        if (!($handle = opendir($dir))){
                return $answer;
        }

        while (false !== ($file = readdir($handle))) {
                if (is_file("$dir/$file")) {
                        $answer[$file] = stat("$dir/$file");
                }
        }
        closedir($handle);
        ksort($answer);

        return $answer; 
}

put_file	(	$	item,
		$	id,
		$	filename,
		$	contents
	)

create an attachment

Parameters:

	$item	-- item type
	$id	-- item id
	$filename	-- the file name
	$contents	-- the file contents

Returns:

nothing

Definition at line 90 of file upload.php.

Referenced by edit_item(), main(), and upload().

                                                    {
        global $upload_base_dir;

        $item = basename($item);
        $id = basename($id);
        $filename = basename($filename);

        if (!is_dir("$upload_base_dir/$item")) {
                mkdir("$upload_base_dir/$item") or 
                user_error("mkdir '$item' failed", E_USER_ERROR); 
        }

        if (!is_dir("$upload_base_dir/$item/$id")) {
                mkdir("$upload_base_dir/$item/$id") or 
                user_error("mkdir '$item/$id' failed", E_USER_ERROR); 
        }

        $file = "$upload_base_dir/$item/$id/$filename";

        if (!($handle = fopen($file, "wb"))){
                user_error("could not open file '$file'", E_USER_ERROR); 
        }

        $c = fwrite($handle,$contents, strlen($contents));
        fclose($handle);

        if ($c != strlen($contents)) {
                user_error("could not write to file '$item/$id/$filename'", 
                        E_USER_ERROR);  
        }
}

upload	(	$	smarty,
		$	INPUT,
		$	db
	)

handle file uploads

This function is called by action.php. It provides a form where the user can upload attachments to documents.

Parameters:

	$smarty	-- Smarty template engine handle
	$db	-- MySQL database handle
	$INPUT['item']	-- item type
	$INPUT['id']	-- item id

Note:

This function uses the global variable $_FILES to retrieve the files that have been uploaded by the user.

Returns:

nothing

Definition at line 136 of file upload.php.

References do_template(), and put_file().

                                      {
        global $_FILES;

        $display_html_form = TRUE;


        if (isset($INPUT['b_ok'])) {

                foreach ($_FILES as $f) {

                        if (!is_uploaded_file($f['tmp_name'])) {
                                continue;
                        }

                        $c = file_get_contents($f['tmp_name']); 
                        $fn = basename($f['name']);
                        put_file($INPUT['item'], $INPUT['id'], $fn, $c);
                        $display_html_form = FALSE;
                }
        }

        if ($display_html_form == TRUE) {
                $tpl_vars = $INPUT;
                do_template($smarty, 'upload.tpl', $tpl_vars);
                exit(0);
        }
}

Here is the call graph for this function:

---