From ac8905e656e34a990e58b3e91607b8600723a133 Mon Sep 17 00:00:00 2001 From: David Faure Date: Wed, 14 Mar 2012 15:38:38 +0100 Subject: trash: Import version 0.6 of the trash spec --- trash/trashspec.html | 119 +++++++++++++++++++++++++++------------------------ 1 file changed, 64 insertions(+), 55 deletions(-) (limited to 'trash') diff --git a/trash/trashspec.html b/trash/trashspec.html index 9e717a5..95e3b29 100644 --- a/trash/trashspec.html +++ b/trash/trashspec.html @@ -5,12 +5,9 @@ Trash specification - - - @@ -21,7 +18,7 @@

Content by David Faure <dfaure@trolltech.com>, Alexander Larsson <alexl@redhat.com> and others on the FreeDesktop.org mailing list

-

Version 0.5

+

Version 0.6

Abstract

The purpose of this Specification is to provide a common way in which all “Trash can” implementations should store, list, @@ -37,21 +34,21 @@ facto standard for today's desktop user experience.

Users do not expect that anything they delete is permanently gone. Instead, they are used to a “Trash can” metaphor. A deleted document ends up in a “Trash can”, and stays -there at least for some time – until the can is manually or +there at least for some time — until the can is manually or automatically cleaned.

This system has its own problems. Notably, cleaning disk space -becomes a two-step operation – delete files and empty trash; +becomes a two-step operation — delete files and empty trash; this can lead to confusion for inexperienced users (“what's taking up my space?!”). Also, it is not easy to adapt the system to a multiuser environment. Besides, there is a potential for -abuse by uneducated users – anecdotal evidence says they +abuse by uneducated users — anecdotal evidence says they sometimes store important documents in the Trash can, and lose them when it gets cleaned!

However, the benefits of this system are so great, and the user expectation for it so high, that it definitely should be implemented on a free desktop system. And in fact, several implementations -already exist – some as command line utilities, some as +already exist — some as command line utilities, some as preloaded libraries, and some as parts of major desktop environments. For example, both Gnome and KDE have their own trash mechanisms.

This Specification is to provide a common way in which all Trash @@ -77,42 +74,42 @@ letters).

A multi-user environment, where users have specific numeric identifiers, is essential for this Specification.

-

File systems and logon systems can be +

File systems and logon systems can be case-sensitive or non-case-sensitive; therefore, systems should generally not allow user names that differ only in case.

Definitions

-

Trash, or Trash can – the storage of files that were trashed +

Trash, or Trash can — the storage of files that were trashed (“deleted”) by the user. These files can be listed, undeleted, or cleaned from the trash can.

-

Trashing – a “delete” operation in which files +

Trashing — a “delete” operation in which files are transferred into the Trash can.

-

Erasing – an operation in which files (possibly already in +

Erasing — an operation in which files (possibly already in the Trash can) are removed (unlinked) from the file system. An erased file is generally considered to be non-recoverable; the space used by this file is freed. [A “shredding” operation, physically overwriting the data, may or may not accompany an erasing operation; the question of shredding is beyond the scope of this document].

-

Original location – the name and location that a file +

Original location — the name and location that a file (currently in the trash) had prior to getting trashed.

-

Original filename – the name that a file (currently in the +

Original filename — the name that a file (currently in the trash) had prior to getting trashed.

-

Top directory , $topdir – the directory where a file system +

Top directory , $topdir — the directory where a file system is mounted. “/” is the top directory for the root file system, but not for the other mounted file systems. For example, separate FSes can be mounted on “/home”, “/mnt/flash”, etc. In this text, the designation “$topdir” is used for “any top directory”.

-

User identifier , $uid – the numeric user identifier for a +

User identifier , $uid — the numeric user identifier for a user. $uid is used here as “the numeric user identifier of the user who is currently logged on”.

-

Trash directory – a directory where trashed files, as well +

Trash directory — a directory where trashed files, as well as the information on their original name/location and time of trashing, are stored. There may be several trash directories on one system; this Specification defines their location and contents. In this text, the designation “$trash” is used for “any trash directory”.

-

“Home trash” directory – a user's main trash +

“Home trash” directory — a user's main trash directory. Its name and location is defined in this document.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD @@ -171,16 +168,16 @@ check for the “sticky bit”. (It MAY provide a way for the administrator, and only the administrator, to disable this checking for a particular top directory, in order to support file systems that do not have the “sticky bit”).

-

The implementation also MUST check that +

The implementation also MUST check that this directory is not a symbolic link.

-

If any of these checks fail, the +

If any of these checks fail, the implementation MUST NOT use this directory for either trashing or undeleting files, even is an appropriate $uid directory (see below) already exists in it. Besides, the implementation SHOULD report the failed check to the administrator, and MAY also report it to the user.

-

The following paragraph applies ONLY to +

The following paragraph applies ONLY to the case when the implementation supports trashing in the top directory, and a $topdir/.Trash exists and has passed the checks:

If the directory exists and passes the @@ -190,19 +187,19 @@ this subdirectory is the numeric identifier of the current user ($topdir/.Trash/$uid). When trashing a file, if this directory does not exist for the current user, the implementation MUST immediately create it, without any warnings or delays for the user.

-

(2) If an $topdir/.Trash directory is +

(2) If an $topdir/.Trash directory is absent, an $topdir/.Trash-$uid directory is to be used as the user's trash directory for this device/partition. $uid is the user's numeric identifier.

-

The following paragraph applies ONLY to +

The following paragraph applies ONLY to the case when the implementation supports trashing in the top directory, and a $topdir/.Trash does not exist or has not passed the checks:

-

When trashing a file, +

When trashing a file, if an $topdir/.Trash-$uid directory does not exist, the implementation MUST immediately create it, without any warnings or delays for the user.

-

When trashing a file, if this directory +

When trashing a file, if this directory does not exist for the current user, the implementation MUST immediately create it, without any warnings or delays for the user.

Notes. If an implementation provides trashing in top @@ -213,15 +210,15 @@ provide the user with some interface to view and/or undelete trashed files, it SHOULD make a “best effort” to show files trashed in top directories (by both methods) to the user, among other trashed files or in a clearly accessible separate way.

-

When trashing a file, if the method (1) fails at any point – +

When trashing a file, if the method (1) fails at any point — i.e. the $topdir/.Trash directory does not exist, or it fails the -checks, or the system refuses to create an $uid directory in it – +checks, or the system refuses to create an $uid directory in it — the implementation MUST, by default, fall back to method (2), described below. Except for the case when $topdir/.Trash fails the checks, the fallback must be immediate, without any warnings or delays. The implementation MAY, however, a way for the administrator to disable (2) completely.

-

If both (1) and (2) fail (i.e. no +

If both (1) and (2) fail (i.e. no $topdir/.Trash directory exists, and an attempt to create $topdir/.Trash-$uid fails), the implementation MUST either trash the file into the user's “home trash” or refuse to trash it. @@ -241,7 +238,7 @@ directory (including the “home trash” directory). This trash directory will be named “$trash” here.

A trash directory contains two subdirectories, named info and files.

-

The $trash/files directory contains the files and +

The $trash/files directory contains the files and directories that were trashed. When a file or directory is trashed, it MUST be moved into this directory5 . The names of files in this directory are to be determined by the @@ -262,7 +259,7 @@ $trash/files is not available, this is an emergency case, and MUST be clearly presented as such to the user or to the system administrator).

-

The $trash/info directory contains an “information +

The $trash/info directory contains an “information file” for every file and directory in $trash/files. This file MUST have exactly the same name as the file or directory in $trash/files, plus the extension “.trashinfo”7. @@ -271,34 +268,34 @@ $trash/files, plus the extension “.trashinfo”Desktop Entry Specification . Its first line must be [Trash Info].

-

It also must have two lines that are +

It also must have two lines that are key/value pairs as described in the Desktop Entry Specification:

-

Example:

-
[Trash Info]
+
Example:

+
[Trash Info]
 Path=foo/bar/meow.bow-wow
 DeletionDate=20040831T22:32:08

 The implementation MUST ignore any other lines in this file, except
@@ -312,14 +309,15 @@ to $trash/files with its entire contents. The names of the files and
 directories within the directory MUST NOT be altered; the
 implementation also SHOULD preserve the access and modification time
 for them.

-
When trashing a file or directory, the implementation SHOULD
-create the corresponding file in $trash/info first. Moreover, it
-SHOULD use O_EXCL when creating it. Before creating this file, or
-before trying again if the creation fails, the implementation should
-check whether a file with the same already exists; if so, the name
-should be changed. (This prevents a race condition if two processes
-try to trash files at the same time, and attempt to use the same file
-name.)

+
When trashing a file or directory, the implementation MUST create
+the corresponding file in $trash/info first. When trashing a file or
+directory, the implementation MUST create thecorresponding file in
+$trash/info first. Moreover, it MUST try to do this in an atomic
+fashion, so that if two processes try trash files with the same
+filename this will result in two different trash files. On Unix-line
+systems this is done by generating a filename, and then opening with
+O_EXCL. If that succeeds the creation was atomic (at least on the
+same machine), if it fails you need to pick another filename.

 
Implementation notes

 
The names of the files/directories in $trash/info SHOULD be
 somehow related to original file names. This can help manual recovery
@@ -352,6 +350,13 @@ undelete it or remove it from the trash only in its entirety as well,
 not as separate files. The user might not have the permissions to
 delete some files in it even while he does have the permission to
 delete the directory!

+
Important note on scope. This specification currently does
+NOT define trashing on remote machines where multiuser permissions
+are implemented but the numeric user ID is not supported, like FTP
+sites and CIFS shares. In systems implementing this specification,
+trashing of files from such machines is to be done only to the user's
+home trash directory (if at all). A future version may address this
+limitation.

 
Administrativia

 
Status of this document

 
This document is, at this moment, only a draft. It will hopefully
@@ -395,6 +400,10 @@ notes. Added a copyright notice.

 
0.4 September 9, 2004. Changed [Trash entry] to [Trash info] and
 fixed some typo's

 
0.5 September 9, 2004. Changed [Trash info] to [Trash Info]

+
0.6 October 8, 2004. Corrections by Alexander Larsson
+<alexl@redhat.com> . Also
+added “note on scope”. Cleaned up HTML. Added a link to this 
+document on the freedesktop.org standards page

 



 

 

-- 
cgit v1.2.3-70-g09d2