2013-07-25 16:48:48 +00:00
|
|
|
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
|
|
|
*
|
|
|
|
* The Original Code is libguac-client-rdp.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Michael Jumper.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2011
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
|
|
|
#ifndef __GUAC_RDPDR_FS_H
|
|
|
|
#define __GUAC_RDPDR_FS_H
|
|
|
|
|
2013-07-31 23:55:13 +00:00
|
|
|
/**
|
|
|
|
* Functions and macros specific to filesystem handling and initialization
|
|
|
|
* independent of RDP. The functions here may deal with the RDPDR device
|
|
|
|
* directly, but their semantics must not deal with RDP protocol messaging.
|
|
|
|
* Functions here represent a virtual Windows-style filesystem on top of UNIX
|
|
|
|
* system calls and structures, using the guac_rdpdr_device structure as a home
|
|
|
|
* for common data.
|
|
|
|
*
|
|
|
|
* @file rdpdr_fs.h
|
|
|
|
*/
|
|
|
|
|
2013-07-25 16:48:48 +00:00
|
|
|
#ifdef ENABLE_WINPR
|
|
|
|
#include <winpr/stream.h>
|
|
|
|
#else
|
|
|
|
#include "compat/winpr-stream.h"
|
|
|
|
#endif
|
|
|
|
|
2013-08-01 20:36:39 +00:00
|
|
|
#include <sys/types.h>
|
|
|
|
#include <dirent.h>
|
|
|
|
|
2013-07-26 17:45:40 +00:00
|
|
|
#include <guacamole/pool.h>
|
|
|
|
|
2013-07-27 18:11:14 +00:00
|
|
|
#include "rdpdr_service.h"
|
|
|
|
|
2013-07-25 16:48:48 +00:00
|
|
|
/**
|
|
|
|
* The index of the blob to use when sending files.
|
|
|
|
*/
|
|
|
|
#define GUAC_RDPDR_FS_BLOB 1
|
|
|
|
|
2013-07-26 17:45:40 +00:00
|
|
|
/**
|
|
|
|
* The maximum number of file IDs to provide.
|
|
|
|
*/
|
|
|
|
#define GUAC_RDPDR_FS_MAX_FILES 128
|
|
|
|
|
2013-07-30 00:57:24 +00:00
|
|
|
/**
|
|
|
|
* The maximum number of bytes in a path string.
|
|
|
|
*/
|
|
|
|
#define GUAC_RDPDR_FS_MAX_PATH 4096
|
|
|
|
|
2013-07-29 19:52:04 +00:00
|
|
|
/**
|
|
|
|
* Error code returned when no more file IDs can be allocated.
|
|
|
|
*/
|
|
|
|
#define GUAC_RDPDR_FS_ENFILE -1
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Error code returned with no such file exists.
|
|
|
|
*/
|
|
|
|
#define GUAC_RDPDR_FS_ENOENT -2
|
|
|
|
|
2013-07-30 00:57:24 +00:00
|
|
|
/*
|
|
|
|
* Access constants.
|
|
|
|
*/
|
2013-09-11 15:52:36 +00:00
|
|
|
#define ACCESS_GENERIC_READ 0x80000000
|
|
|
|
#define ACCESS_GENERIC_WRITE 0x40000000
|
|
|
|
#define ACCESS_GENERIC_ALL 0x10000000
|
|
|
|
#define ACCESS_FILE_READ_DATA 0x00000001
|
|
|
|
#define ACCESS_FILE_WRITE_DATA 0x00000002
|
|
|
|
#define ACCESS_FILE_APPEND_DATA 0x00000004
|
|
|
|
#define ACCESS_DELETE 0x00010000
|
2013-07-30 00:57:24 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Create disposition constants.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define DISP_FILE_SUPERSEDE 0x00000000
|
|
|
|
#define DISP_FILE_OPEN 0x00000001
|
|
|
|
#define DISP_FILE_CREATE 0x00000002
|
|
|
|
#define DISP_FILE_OPEN_IF 0x00000003
|
|
|
|
#define DISP_FILE_OVERWRITE 0x00000004
|
|
|
|
#define DISP_FILE_OVERWRITE_IF 0x00000005
|
|
|
|
|
2013-07-26 17:45:40 +00:00
|
|
|
/*
|
|
|
|
* Information constants.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define FILE_SUPERSEDED 0x00000000
|
|
|
|
#define FILE_OPENED 0x00000001
|
2013-07-26 23:21:01 +00:00
|
|
|
#define FILE_OVERWRITTEN 0x00000003a
|
|
|
|
|
|
|
|
/*
|
|
|
|
* File attributes.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define FILE_ATTRIBUTE_READONLY 0x00000001
|
|
|
|
#define FILE_ATTRIBUTE_DIRECTORY 0x00000010
|
|
|
|
#define FILE_ATTRIBUTE_NORMAL 0x00000080
|
|
|
|
|
|
|
|
#define SEC_TO_UNIX_EPOCH 11644473600
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Converts a Windows timestamp (100 nanosecond intervals since Jan 1, 1601
|
|
|
|
* UTC) to UNIX timestamp (seconds since Jan 1, 1970 UTC).
|
|
|
|
*
|
|
|
|
* This conversion is lossy.
|
|
|
|
*/
|
|
|
|
#define UNIX_TIME(t) ((time_t) ((t / 10000000 + ((uint64_t) 11644473600))))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Converts a UNIX timestamp (seconds since Jan 1, 1970 UTC) to Windows
|
|
|
|
* timestamp (100 nanosecond intervals since Jan 1, 1601 UTC).
|
|
|
|
*/
|
|
|
|
#define WINDOWS_TIME(t) ((t - ((uint64_t) 11644473600)) * 10000000)
|
2013-07-26 17:45:40 +00:00
|
|
|
|
2013-07-26 21:11:44 +00:00
|
|
|
/**
|
|
|
|
* An arbitrary file on the virtual filesystem of the Guacamole drive.
|
|
|
|
*/
|
|
|
|
typedef struct guac_rdpdr_fs_file {
|
|
|
|
|
2013-08-01 20:44:30 +00:00
|
|
|
/**
|
2013-08-03 00:23:09 +00:00
|
|
|
* The absolute path, including filename, of this file.
|
2013-08-01 20:44:30 +00:00
|
|
|
*/
|
2013-08-03 00:23:09 +00:00
|
|
|
char* absolute_path;
|
2013-08-01 20:44:30 +00:00
|
|
|
|
2013-07-26 21:11:44 +00:00
|
|
|
/**
|
|
|
|
* Associated local file descriptor.
|
|
|
|
*/
|
|
|
|
int fd;
|
|
|
|
|
2013-08-01 20:36:39 +00:00
|
|
|
/**
|
|
|
|
* Associated directory stream, if any. This field only applies
|
|
|
|
* if the file is being used as a directory.
|
|
|
|
*/
|
|
|
|
DIR* dir;
|
|
|
|
|
2013-08-02 00:44:39 +00:00
|
|
|
/**
|
|
|
|
* The last read dirent structure. This is used if traversing the contents
|
|
|
|
* of a directory.
|
|
|
|
*/
|
|
|
|
struct dirent __dirent;
|
|
|
|
|
2013-09-17 21:26:05 +00:00
|
|
|
/**
|
|
|
|
* The pattern the check directory contents against, if any.
|
|
|
|
*/
|
|
|
|
char dir_pattern[GUAC_RDPDR_FS_MAX_PATH];
|
|
|
|
|
2013-08-03 00:23:09 +00:00
|
|
|
/**
|
|
|
|
* Bitwise OR of all associated Windows file attributes.
|
|
|
|
*/
|
|
|
|
int attributes;
|
|
|
|
|
2013-08-01 20:36:39 +00:00
|
|
|
/**
|
|
|
|
* The size of this file, in bytes.
|
|
|
|
*/
|
2013-08-03 00:23:09 +00:00
|
|
|
int size;
|
2013-08-01 20:36:39 +00:00
|
|
|
|
|
|
|
/**
|
2013-08-03 00:23:09 +00:00
|
|
|
* The time this file was created, as a Windows timestamp.
|
2013-08-01 20:36:39 +00:00
|
|
|
*/
|
2013-08-03 00:23:09 +00:00
|
|
|
uint64_t ctime;
|
2013-08-01 20:36:39 +00:00
|
|
|
|
|
|
|
/**
|
2013-08-03 00:23:09 +00:00
|
|
|
* The time this file was last modified, as a Windows timestamp.
|
2013-08-01 20:36:39 +00:00
|
|
|
*/
|
2013-08-03 00:23:09 +00:00
|
|
|
uint64_t mtime;
|
2013-08-01 20:36:39 +00:00
|
|
|
|
|
|
|
/**
|
2013-08-03 00:23:09 +00:00
|
|
|
* The time this file was last accessed, as a Windows timestamp.
|
2013-08-01 20:36:39 +00:00
|
|
|
*/
|
2013-08-03 00:23:09 +00:00
|
|
|
uint64_t atime;
|
2013-08-01 20:36:39 +00:00
|
|
|
|
2013-07-26 21:11:44 +00:00
|
|
|
} guac_rdpdr_fs_file;
|
|
|
|
|
2013-07-25 16:48:48 +00:00
|
|
|
/**
|
|
|
|
* Data specific to an instance of the printer device.
|
|
|
|
*/
|
|
|
|
typedef struct guac_rdpdr_fs_data {
|
|
|
|
|
2013-07-26 17:45:40 +00:00
|
|
|
/**
|
|
|
|
* The number of currently open files.
|
|
|
|
*/
|
|
|
|
int open_files;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Pool of file IDs.
|
|
|
|
*/
|
|
|
|
guac_pool* file_id_pool;
|
2013-07-25 16:48:48 +00:00
|
|
|
|
2013-07-26 21:11:44 +00:00
|
|
|
/**
|
|
|
|
* All available file structures.
|
|
|
|
*/
|
|
|
|
guac_rdpdr_fs_file files[GUAC_RDPDR_FS_MAX_FILES];
|
|
|
|
|
2013-07-25 16:48:48 +00:00
|
|
|
} guac_rdpdr_fs_data;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Registers a new filesystem device within the RDPDR plugin. This must be done
|
|
|
|
* before RDPDR connection finishes.
|
|
|
|
*/
|
|
|
|
void guac_rdpdr_register_fs(guac_rdpdrPlugin* rdpdr);
|
|
|
|
|
2013-08-02 20:35:52 +00:00
|
|
|
/**
|
|
|
|
* Converts the given relative path to an absolute path based on the given
|
|
|
|
* parent path. If the path cannot be converted, non-zero is returned.
|
|
|
|
*/
|
|
|
|
int guac_rdpdr_fs_convert_path(const char* parent, const char* rel_path, char* abs_path);
|
|
|
|
|
2013-07-26 17:45:40 +00:00
|
|
|
/**
|
2013-07-31 23:55:13 +00:00
|
|
|
* Returns the next available file ID, or an error code less than zero
|
|
|
|
* if an error occurs.
|
2013-07-26 17:45:40 +00:00
|
|
|
*/
|
2013-07-30 00:57:24 +00:00
|
|
|
int guac_rdpdr_fs_open(guac_rdpdr_device* device, const char* path,
|
|
|
|
int access, int create_disposition);
|
2013-07-26 17:45:40 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Frees the given file ID, allowing future open operations to reuse it.
|
|
|
|
*/
|
|
|
|
void guac_rdpdr_fs_close(guac_rdpdr_device* device, int file_id);
|
|
|
|
|
2013-08-02 20:35:52 +00:00
|
|
|
/**
|
|
|
|
* Given an arbitrary path, which may contain ".." and ".", creates an
|
|
|
|
* absolute path which does NOT contain ".." or ".".
|
|
|
|
*/
|
|
|
|
int guac_rdpdr_fs_normalize_path(const char* path, char* abs_path);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Given a parent path and a relative path, produces a normalized absolute path.
|
|
|
|
*/
|
|
|
|
int guac_rdpdr_fs_convert_path(const char* parent, const char* rel_path, char* abs_path);
|
|
|
|
|
2013-08-02 00:44:39 +00:00
|
|
|
/**
|
|
|
|
* Returns the next filename within the directory having the given file ID,
|
|
|
|
* or NULL if no more files.
|
|
|
|
*/
|
|
|
|
const char* guac_rdpdr_fs_read_dir(guac_rdpdr_device* device, int file_id);
|
|
|
|
|
2013-09-16 21:01:08 +00:00
|
|
|
/**
|
|
|
|
* Returns the file having the given ID, or NULL if no such file exists.
|
|
|
|
*/
|
|
|
|
guac_rdpdr_fs_file* guac_rdpdr_fs_get_file(guac_rdpdr_device* device,
|
|
|
|
int file_id);
|
|
|
|
|
2013-09-17 21:26:05 +00:00
|
|
|
/**
|
|
|
|
* Returns whether the given filename matches the given pattern.
|
|
|
|
*/
|
|
|
|
int guac_rdpdr_fs_matches(const char* filename, const char* pattern);
|
|
|
|
|
2013-07-25 16:48:48 +00:00
|
|
|
#endif
|
|
|
|
|