87 lines
3.5 KiB
Text
87 lines
3.5 KiB
Text
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2008 by Sun Microsystems, Inc.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: FilePermission.idl,v $
|
|
* $Revision: 1.11 $
|
|
*
|
|
* This file is part of OpenOffice.org.
|
|
*
|
|
* OpenOffice.org is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License version 3
|
|
* only, as published by the Free Software Foundation.
|
|
*
|
|
* OpenOffice.org 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 Lesser General Public License version 3 for more details
|
|
* (a copy is included in the LICENSE file that accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* version 3 along with OpenOffice.org. If not, see
|
|
* <http://www.openoffice.org/license.html>
|
|
* for a copy of the LGPLv3 License.
|
|
*
|
|
************************************************************************/
|
|
#ifndef __com_sun_star_io_FilePermission_idl__
|
|
#define __com_sun_star_io_FilePermission_idl__
|
|
//=============================================================================
|
|
|
|
module com { module sun { module star { module io {
|
|
|
|
//=============================================================================
|
|
|
|
/** This permission represents access to a file or directory.
|
|
A FilePermission consists of a file url and a set of actions valid for that url.
|
|
<p>
|
|
The path of the file url that ends in <code>"/*"</code> indicates all the files and
|
|
directories contained in that directory. A path that ends with <code>"/-"</code>
|
|
indicates (recursively) all files and subdirectories contained in that
|
|
directory. A file url string consisting of the special token
|
|
<code>"<<ALL FILES>>"</code> matches any file.
|
|
<br>
|
|
Note: A file url string consisting of a single <code>"*"</code> indicates all the files
|
|
in the current directory, while a string consisting of a single <code>"-"</code> indicates
|
|
all the files in the current directory and (recursively) all files and
|
|
subdirectories contained in the current directory.
|
|
<br>
|
|
The actions to be granted is a list of one or more comma-separated keywords.
|
|
The possible keywords are <code>"read"</code>, <code>"write"</code>,
|
|
<code>"execute"</code>, and <code>"delete"</code>.
|
|
Their meaning is defined as follows:
|
|
<ul>
|
|
<li><code>read</code> -- read permission</li>
|
|
<li><code>write</code> -- write permission</li>
|
|
<li><code>execute</code> -- execute permission</li>
|
|
<li><code>delete</code> -- delete permission</li>
|
|
</ul><br>
|
|
The actions string is processed case-insensitive.
|
|
</p>
|
|
|
|
@attention
|
|
Be careful when granting FilePermissions. Think about the implications of
|
|
granting read and especially write access to various files and directories.
|
|
The <code>"<<ALL FILES>>"</code> permission with write action is
|
|
especially dangerous. This grants permission to write to the entire file system.
|
|
|
|
@since OOo 1.1.2
|
|
*/
|
|
published struct FilePermission
|
|
{
|
|
/** target file url
|
|
*/
|
|
string URL;
|
|
/** comma separated actions list
|
|
*/
|
|
string Actions;
|
|
};
|
|
|
|
//=============================================================================
|
|
|
|
}; }; }; };
|
|
|
|
#endif
|