mirror of
https://github.com/arsenetar/send2trash.git
synced 2026-01-25 16:11:39 +00:00
Compare commits
64 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7d38de269a | ||
| 5733670fc2 | |||
|
|
22ed5dc09b | ||
|
|
3071684f73 | ||
|
|
75a9cd6b55 | ||
|
|
f38aec6569 | ||
|
|
072e28cb1e | ||
|
|
016b90c1ac | ||
|
|
f324ff491e | ||
|
|
f3231ef857 | ||
|
|
b7e3057853 | ||
|
|
7fece243d8 | ||
|
|
4181ed65e9 | ||
|
|
dd69edad3b | ||
|
|
bd9183afe9 | ||
|
|
f6f63b1796 | ||
|
|
0974912e78 | ||
|
|
6c01453fd3 | ||
|
|
7cbefa4317 | ||
|
|
72bc94b48d | ||
|
|
35ad95bcd5 | ||
|
|
a568370c6a | ||
|
|
baf125ff61 | ||
|
|
bb8ed834da | ||
|
|
a8dbb1ac63 | ||
|
|
bfd8f6e024 | ||
|
|
8996fb9eac | ||
|
|
f7a6f217ce | ||
|
|
a4936be846 | ||
|
|
0f95d7506e | ||
|
|
b415ac86e3 | ||
|
|
eeaf4e8ffa | ||
|
|
798893215c | ||
|
|
aee2b7a8af | ||
|
|
d090156c45 | ||
|
|
358b705cbc | ||
|
|
eedbe258cb | ||
|
|
18e3187c2f | ||
|
|
8001be8f37 | ||
|
|
13b3943c82 | ||
|
|
a8a771c9bd | ||
|
|
9189e685b1 | ||
|
|
04ee6eaf9f | ||
|
|
506e48b2e0 | ||
|
|
899a3efeb3 | ||
|
|
a6907d57a9 | ||
|
|
51d8a51cb7 | ||
|
|
b5315cb73d | ||
|
|
86450a3dee | ||
|
|
d1fcb13086 | ||
|
|
31907c9c4a | ||
|
|
02dc392c45 | ||
|
|
2572a7c00c | ||
|
|
7546aa606a | ||
|
|
2858b5b153 | ||
|
|
88b90d859c | ||
|
|
f5f9c5b352 | ||
|
|
06f03e14b4 | ||
|
|
8313b0eebb | ||
|
|
e78d1d1bd9 | ||
|
|
de898fdcaa | ||
|
|
a3e41602cf | ||
|
|
8b00632dd6 | ||
|
|
fa68152b35 |
7
.gitignore
vendored
Normal file
7
.gitignore
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
*.pyc
|
||||
*.egg-info
|
||||
/build
|
||||
/dist
|
||||
.DS_Store
|
||||
/.tox
|
||||
__pycache__
|
||||
10
.travis.yml
Normal file
10
.travis.yml
Normal file
@@ -0,0 +1,10 @@
|
||||
language: python
|
||||
python:
|
||||
- "2.7"
|
||||
- "3.4"
|
||||
- "3.5"
|
||||
- "3.6"
|
||||
install:
|
||||
- "pip install tox"
|
||||
script:
|
||||
- "tox -e $(echo py$TRAVIS_PYTHON_VERSION | tr -d .)"
|
||||
54
CHANGES.rst
Normal file
54
CHANGES.rst
Normal file
@@ -0,0 +1,54 @@
|
||||
Changes
|
||||
=======
|
||||
|
||||
Version 1.4.2 -- 2017/11/17
|
||||
---------------------------
|
||||
|
||||
* Fix incompatibility with Python 3.6 on Windows. (#18)
|
||||
|
||||
Version 1.4.1 -- 2017/08/07
|
||||
---------------------------
|
||||
|
||||
* Fix crash on Windows introduced in v1.4.0. Oops... (#14)
|
||||
|
||||
Version 1.4.0 -- 2017/08/07
|
||||
---------------------------
|
||||
|
||||
* Use ``bytes`` instead of ``str`` for internal path handling in ``plat_other``. (#13)
|
||||
|
||||
Version 1.3.1 -- 2017/07/31
|
||||
---------------------------
|
||||
|
||||
* Throw ``WindowsError`` instead of ``OSError`` in ``plat_win``. (#7)
|
||||
* Fix ``TypeError`` on python 2 in ``plat_other``. (#12)
|
||||
|
||||
Version 1.3.0 -- 2013/07/19
|
||||
---------------------------
|
||||
|
||||
* Added support for Gnome's GIO.
|
||||
* Merged Python 3 and Python 2 versions in a single codebase.
|
||||
|
||||
Version 1.2.0 -- 2011/03/16
|
||||
---------------------------
|
||||
|
||||
* Improved ``plat_other`` to follow freedesktop.org trash specification.
|
||||
|
||||
Version 1.1.0 -- 2010/10/18
|
||||
---------------------------
|
||||
|
||||
* Converted compiled modules to ctypes so that cross-platform compilation isn't necessary anymore.
|
||||
|
||||
Version 1.0.2 -- 2010/07/10
|
||||
---------------------------
|
||||
|
||||
* Fixed bugs with external volumes in plat_other.
|
||||
|
||||
Version 1.0.1 -- 2010/04/19
|
||||
---------------------------
|
||||
|
||||
* Fixed memory leak in OS X module.
|
||||
|
||||
Version 1.0.0 -- 2010/04/07
|
||||
---------------------------
|
||||
|
||||
* Initial Release
|
||||
4
LICENSE
4
LICENSE
@@ -1,4 +1,4 @@
|
||||
Copyright (c) 2010, Hardcoded Software Inc., http://www.hardcoded.net
|
||||
Copyright (c) 2017, Virgil Dupras
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||
@@ -7,4 +7,4 @@ Redistribution and use in source and binary forms, with or without modification,
|
||||
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||
* Neither the name of Hardcoded Software Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
1
MANIFEST.in
Normal file
1
MANIFEST.in
Normal file
@@ -0,0 +1 @@
|
||||
include CHANGES.rst
|
||||
25
README
25
README
@@ -1,25 +0,0 @@
|
||||
==================================================
|
||||
Send2Trash -- Send files to trash on all platforms
|
||||
==================================================
|
||||
|
||||
Send2Trash is a small package that sends files to the Trash (or Recycle Bin) *natively* and on
|
||||
*all platforms*. On OS X, it uses native ``FSMoveObjectToTrashSync`` Cocoa calls, on Windows, it uses native (and ugly) ``SHFileOperation`` win32 calls. On other platforms, it moves the file to the first folder it finds that looks like a trash (so far, it's known to work on Ubuntu).
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Download the source from http://hg.hardcoded.net/send2trash and install it with::
|
||||
|
||||
>>> sudo python setup.py install
|
||||
|
||||
On Windows, you'll need Visual Studio 2008 to compile it. Note that the install you'll get will not be a "universal" package. If you install it on OS X, only the "osx" module will be compiled, and if you install it on Windows, only the "win" module will be compiled.
|
||||
|
||||
To have a cross-platform package you can ship around, you'll have compile the package on both platforms and merge the results so that both compiled modules are in the same package.
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
>>> from send2trash import send2trash
|
||||
>>> send2trash('some_file')
|
||||
|
||||
When there's a problem ``OSError`` is raised.
|
||||
36
README.rst
Normal file
36
README.rst
Normal file
@@ -0,0 +1,36 @@
|
||||
==================================================
|
||||
Send2Trash -- Send files to trash on all platforms
|
||||
==================================================
|
||||
|
||||
Send2Trash is a small package that sends files to the Trash (or Recycle Bin) *natively* and on
|
||||
*all platforms*. On OS X, it uses native ``FSMoveObjectToTrashSync`` Cocoa calls, on Windows, it
|
||||
uses native (and ugly) ``SHFileOperation`` win32 calls. On other platforms, if `PyGObject`_ and
|
||||
`GIO`_ are available, it will use this. Otherwise, it will fallback to its own implementation
|
||||
of the `trash specifications from freedesktop.org`_.
|
||||
|
||||
``ctypes`` is used to access native libraries, so no compilation is necessary.
|
||||
|
||||
Send2Trash supports Python 2.7 and up (Python 3 is supported).
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
You can download it with pip::
|
||||
|
||||
pip install Send2Trash
|
||||
|
||||
or you can download the source from http://github.com/hsoft/send2trash and install it with::
|
||||
|
||||
>>> python setup.py install
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
>>> from send2trash import send2trash
|
||||
>>> send2trash('some_file')
|
||||
|
||||
When there's a problem ``OSError`` is raised.
|
||||
|
||||
.. _PyGObject: https://wiki.gnome.org/PyGObject
|
||||
.. _GIO: https://developer.gnome.org/gio/
|
||||
.. _trash specifications from freedesktop.org: http://freedesktop.org/wiki/Specifications/trash-spec/
|
||||
@@ -1,44 +0,0 @@
|
||||
/* Copyright 2010 Hardcoded Software (http://www.hardcoded.net)
|
||||
|
||||
This software is licensed under the "BSD" License as described in the "LICENSE" file,
|
||||
which should be included with this package. The terms are also available at
|
||||
http://www.hardcoded.net/licenses/bsd_license
|
||||
*/
|
||||
|
||||
#define PY_SSIZE_T_CLEAN
|
||||
#include "Python.h"
|
||||
#include <CoreServices/CoreServices.h>
|
||||
|
||||
static PyObject* send2trash_osx_send(PyObject *self, PyObject *args)
|
||||
{
|
||||
UInt8 *utf8_chars;
|
||||
FSRef fp;
|
||||
OSStatus op_result;
|
||||
|
||||
if (!PyArg_ParseTuple(args, "es", "utf-8", &utf8_chars)) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
FSPathMakeRefWithOptions(utf8_chars, kFSPathMakeRefDoNotFollowLeafSymlink, &fp, NULL);
|
||||
op_result = FSMoveObjectToTrashSync(&fp, NULL, kFSFileOperationDefaultOptions);
|
||||
if (op_result != noErr) {
|
||||
PyErr_SetString(PyExc_OSError, GetMacOSStatusCommentString(op_result));
|
||||
return NULL;
|
||||
}
|
||||
return Py_None;
|
||||
}
|
||||
|
||||
static PyMethodDef TrashMethods[] = {
|
||||
{"send", send2trash_osx_send, METH_VARARGS, ""},
|
||||
{NULL, NULL, 0, NULL}
|
||||
};
|
||||
|
||||
PyMODINIT_FUNC
|
||||
init_send2trash_osx(void)
|
||||
{
|
||||
PyObject *m = Py_InitModule("_send2trash_osx", TrashMethods);
|
||||
if (m == NULL) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,68 +0,0 @@
|
||||
/* Copyright 2010 Hardcoded Software (http://www.hardcoded.net)
|
||||
|
||||
This software is licensed under the "BSD" License as described in the "LICENSE" file,
|
||||
which should be included with this package. The terms are also available at
|
||||
http://www.hardcoded.net/licenses/bsd_license
|
||||
*/
|
||||
|
||||
#define PY_SSIZE_T_CLEAN
|
||||
#include "Python.h"
|
||||
|
||||
#define WINDOWS_LEAN_AND_MEAN
|
||||
#include "windows.h"
|
||||
#include "shlobj.h"
|
||||
|
||||
/* WARNING: If the filepath is not fully qualified, Windows deletes the file
|
||||
rather than sending it to trash.
|
||||
*/
|
||||
|
||||
static PyObject* send2trash_win_send(PyObject *self, PyObject *args)
|
||||
{
|
||||
SHFILEOPSTRUCTW op;
|
||||
PyObject *filepath;
|
||||
Py_ssize_t len;
|
||||
WCHAR filechars[MAX_PATH+1];
|
||||
int r;
|
||||
|
||||
if (!PyArg_ParseTuple(args, "O", &filepath)) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
if (!PyUnicode_Check(filepath)) {
|
||||
PyErr_SetString(PyExc_TypeError, "Unicode filename required");
|
||||
return NULL;
|
||||
}
|
||||
|
||||
len = PyUnicode_GET_SIZE(filepath);
|
||||
memcpy(filechars, PyUnicode_AsUnicode(filepath), sizeof(WCHAR)*len);
|
||||
filechars[len] = '\0';
|
||||
filechars[len+1] = '\0';
|
||||
|
||||
op.hwnd = 0;
|
||||
op.wFunc = FO_DELETE;
|
||||
op.pFrom = (LPCWSTR)&filechars;
|
||||
op.pTo = NULL;
|
||||
op.fFlags = FOF_ALLOWUNDO | FOF_NOCONFIRMATION | FOF_NOERRORUI | FOF_SILENT;
|
||||
r = SHFileOperationW(&op);
|
||||
|
||||
if (r != 0) {
|
||||
PyErr_Format(PyExc_OSError, "Couldn't perform operation. Error code: %d", r);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
return Py_None;
|
||||
}
|
||||
|
||||
static PyMethodDef TrashMethods[] = {
|
||||
{"send", send2trash_win_send, METH_VARARGS, ""},
|
||||
{NULL, NULL, 0, NULL}
|
||||
};
|
||||
|
||||
PyMODINIT_FUNC
|
||||
init_send2trash_win(void)
|
||||
{
|
||||
PyObject *m = Py_InitModule("_send2trash_win", TrashMethods);
|
||||
if (m == NULL) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
# Copyright 2010 Hardcoded Software (http://www.hardcoded.net)
|
||||
# Copyright 2013 Hardcoded Software (http://www.hardcoded.net)
|
||||
|
||||
# This software is licensed under the "BSD" License as described in the "LICENSE" file,
|
||||
# which should be included with this package. The terms are also available at
|
||||
@@ -7,8 +7,13 @@
|
||||
import sys
|
||||
|
||||
if sys.platform == 'darwin':
|
||||
from plat_osx import send2trash
|
||||
from .plat_osx import send2trash
|
||||
elif sys.platform == 'win32':
|
||||
from plat_win import send2trash
|
||||
from .plat_win import send2trash
|
||||
else:
|
||||
from plat_other import send2trash
|
||||
try:
|
||||
# If we can use gio, let's use it
|
||||
from .plat_gio import send2trash
|
||||
except ImportError:
|
||||
# Oh well, let's fallback to our own Freedesktop trash implementation
|
||||
from .plat_other import send2trash
|
||||
|
||||
20
send2trash/compat.py
Normal file
20
send2trash/compat.py
Normal file
@@ -0,0 +1,20 @@
|
||||
# Copyright 2017 Virgil Dupras
|
||||
|
||||
# This software is licensed under the "BSD" License as described in the "LICENSE" file,
|
||||
# which should be included with this package. The terms are also available at
|
||||
# http://www.hardcoded.net/licenses/bsd_license
|
||||
|
||||
import sys
|
||||
import os
|
||||
|
||||
PY3 = sys.version_info[0] >= 3
|
||||
if PY3:
|
||||
text_type = str
|
||||
binary_type = bytes
|
||||
if os.supports_bytes_environ:
|
||||
# environb will be unset under Windows, but then again we're not supposed to use it.
|
||||
environb = os.environb
|
||||
else:
|
||||
text_type = unicode
|
||||
binary_type = str
|
||||
environb = os.environ
|
||||
14
send2trash/plat_gio.py
Normal file
14
send2trash/plat_gio.py
Normal file
@@ -0,0 +1,14 @@
|
||||
# Copyright 2017 Virgil Dupras
|
||||
|
||||
# This software is licensed under the "BSD" License as described in the "LICENSE" file,
|
||||
# which should be included with this package. The terms are also available at
|
||||
# http://www.hardcoded.net/licenses/bsd_license
|
||||
|
||||
from gi.repository import GObject, Gio
|
||||
|
||||
def send2trash(path):
|
||||
try:
|
||||
f = Gio.File.new_for_path(path)
|
||||
f.trash(cancellable=None)
|
||||
except GObject.GError as e:
|
||||
raise OSError(e.message)
|
||||
@@ -1,12 +1,48 @@
|
||||
# Copyright 2010 Hardcoded Software (http://www.hardcoded.net)
|
||||
# Copyright 2017 Virgil Dupras
|
||||
|
||||
# This software is licensed under the "BSD" License as described in the "LICENSE" file,
|
||||
# which should be included with this package. The terms are also available at
|
||||
# This software is licensed under the "BSD" License as described in the "LICENSE" file,
|
||||
# which should be included with this package. The terms are also available at
|
||||
# http://www.hardcoded.net/licenses/bsd_license
|
||||
|
||||
import _send2trash_osx
|
||||
from __future__ import unicode_literals
|
||||
|
||||
from ctypes import cdll, byref, Structure, c_char, c_char_p
|
||||
from ctypes.util import find_library
|
||||
|
||||
from .compat import binary_type
|
||||
|
||||
Foundation = cdll.LoadLibrary(find_library('Foundation'))
|
||||
CoreServices = cdll.LoadLibrary(find_library('CoreServices'))
|
||||
|
||||
GetMacOSStatusCommentString = Foundation.GetMacOSStatusCommentString
|
||||
GetMacOSStatusCommentString.restype = c_char_p
|
||||
FSPathMakeRefWithOptions = CoreServices.FSPathMakeRefWithOptions
|
||||
FSMoveObjectToTrashSync = CoreServices.FSMoveObjectToTrashSync
|
||||
|
||||
kFSPathMakeRefDefaultOptions = 0
|
||||
kFSPathMakeRefDoNotFollowLeafSymlink = 0x01
|
||||
|
||||
kFSFileOperationDefaultOptions = 0
|
||||
kFSFileOperationOverwrite = 0x01
|
||||
kFSFileOperationSkipSourcePermissionErrors = 0x02
|
||||
kFSFileOperationDoNotMoveAcrossVolumes = 0x04
|
||||
kFSFileOperationSkipPreflight = 0x08
|
||||
|
||||
class FSRef(Structure):
|
||||
_fields_ = [('hidden', c_char * 80)]
|
||||
|
||||
def check_op_result(op_result):
|
||||
if op_result:
|
||||
msg = GetMacOSStatusCommentString(op_result).decode('utf-8')
|
||||
raise OSError(msg)
|
||||
|
||||
def send2trash(path):
|
||||
if not isinstance(path, unicode):
|
||||
path = unicode(path, 'utf-8')
|
||||
_send2trash_osx.send(path)
|
||||
if not isinstance(path, binary_type):
|
||||
path = path.encode('utf-8')
|
||||
fp = FSRef()
|
||||
opts = kFSPathMakeRefDoNotFollowLeafSymlink
|
||||
op_result = FSPathMakeRefWithOptions(path, opts, byref(fp), None)
|
||||
check_op_result(op_result)
|
||||
opts = kFSFileOperationDefaultOptions
|
||||
op_result = FSMoveObjectToTrashSync(byref(fp), None, opts)
|
||||
check_op_result(op_result)
|
||||
|
||||
@@ -1,71 +1,186 @@
|
||||
# Copyright 2017 Virgil Dupras
|
||||
|
||||
# This software is licensed under the "BSD" License as described in the "LICENSE" file,
|
||||
# which should be included with this package. The terms are also available at
|
||||
# http://www.hardcoded.net/licenses/bsd_license
|
||||
|
||||
# This is a reimplementation of plat_other.py with reference to the
|
||||
# freedesktop.org trash specification:
|
||||
# [1] http://www.freedesktop.org/wiki/Specifications/trash-spec
|
||||
# [2] http://www.ramendik.ru/docs/trashspec.html
|
||||
# See also:
|
||||
# [3] http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
|
||||
#
|
||||
# For external volumes this implementation will raise an exception if it can't
|
||||
# find or create the user's trash directory.
|
||||
|
||||
from __future__ import unicode_literals
|
||||
|
||||
import sys
|
||||
import os
|
||||
import os.path as op
|
||||
# Copyright 2010 Hardcoded Software (http://www.hardcoded.net)
|
||||
from datetime import datetime
|
||||
import stat
|
||||
try:
|
||||
from urllib.parse import quote
|
||||
except ImportError:
|
||||
# Python 2
|
||||
from urllib import quote
|
||||
|
||||
# This software is licensed under the "BSD" License as described in the "LICENSE" file,
|
||||
# which should be included with this package. The terms are also available at
|
||||
# http://www.hardcoded.net/licenses/bsd_license
|
||||
from .compat import text_type, environb
|
||||
|
||||
import logging
|
||||
try:
|
||||
fsencode = os.fsencode # Python 3
|
||||
fsdecode = os.fsdecode
|
||||
except AttributeError:
|
||||
def fsencode(u): # Python 2
|
||||
return u.encode(sys.getfilesystemencoding())
|
||||
def fsdecode(b):
|
||||
return b.decode(sys.getfilesystemencoding())
|
||||
# The Python 3 versions are a bit smarter, handling surrogate escapes,
|
||||
# but these should work in most cases.
|
||||
|
||||
CANDIDATES = [
|
||||
'~/.local/share/Trash/files',
|
||||
'~/.Trash',
|
||||
]
|
||||
FILES_DIR = b'files'
|
||||
INFO_DIR = b'info'
|
||||
INFO_SUFFIX = b'.trashinfo'
|
||||
|
||||
for candidate in CANDIDATES:
|
||||
candidate_path = op.expanduser(candidate)
|
||||
if op.exists(candidate_path):
|
||||
TRASH_PATH = candidate_path
|
||||
break
|
||||
else:
|
||||
logging.warning("Can't find path for Trash")
|
||||
TRASH_PATH = op.expanduser('~/.Trash')
|
||||
# Default of ~/.local/share [3]
|
||||
XDG_DATA_HOME = op.expanduser(environb.get(b'XDG_DATA_HOME', b'~/.local/share'))
|
||||
HOMETRASH_B = op.join(XDG_DATA_HOME, b'Trash')
|
||||
HOMETRASH = fsdecode(HOMETRASH_B)
|
||||
|
||||
EXTERNAL_CANDIDATES = [
|
||||
'.Trash-1000/files',
|
||||
'.Trash/files',
|
||||
'.Trash-1000',
|
||||
'.Trash',
|
||||
]
|
||||
uid = os.getuid()
|
||||
TOPDIR_TRASH = b'.Trash'
|
||||
TOPDIR_FALLBACK = b'.Trash-' + text_type(uid).encode('ascii')
|
||||
|
||||
def is_parent(parent, path):
|
||||
path = op.realpath(path) # In case it's a symlink
|
||||
if isinstance(path, text_type):
|
||||
path = fsencode(path)
|
||||
parent = op.realpath(parent)
|
||||
if isinstance(parent, text_type):
|
||||
parent = fsencode(parent)
|
||||
return path.startswith(parent)
|
||||
|
||||
def format_date(date):
|
||||
return date.strftime("%Y-%m-%dT%H:%M:%S")
|
||||
|
||||
def info_for(src, topdir):
|
||||
# ...it MUST not include a ".." directory, and for files not "under" that
|
||||
# directory, absolute pathnames must be used. [2]
|
||||
if topdir is None or not is_parent(topdir, src):
|
||||
src = op.abspath(src)
|
||||
else:
|
||||
src = op.relpath(src, topdir)
|
||||
|
||||
info = "[Trash Info]\n"
|
||||
info += "Path=" + quote(src) + "\n"
|
||||
info += "DeletionDate=" + format_date(datetime.now()) + "\n"
|
||||
return info
|
||||
|
||||
def check_create(dir):
|
||||
# use 0700 for paths [3]
|
||||
if not op.exists(dir):
|
||||
os.makedirs(dir, 0o700)
|
||||
|
||||
def trash_move(src, dst, topdir=None):
|
||||
filename = op.basename(src)
|
||||
filespath = op.join(dst, FILES_DIR)
|
||||
infopath = op.join(dst, INFO_DIR)
|
||||
base_name, ext = op.splitext(filename)
|
||||
|
||||
counter = 0
|
||||
destname = filename
|
||||
while op.exists(op.join(filespath, destname)) or op.exists(op.join(infopath, destname + INFO_SUFFIX)):
|
||||
counter += 1
|
||||
destname = base_name + b' ' + text_type(counter).encode('ascii') + ext
|
||||
|
||||
check_create(filespath)
|
||||
check_create(infopath)
|
||||
|
||||
os.rename(src, op.join(filespath, destname))
|
||||
f = open(op.join(infopath, destname + INFO_SUFFIX), 'w')
|
||||
f.write(info_for(src, topdir))
|
||||
f.close()
|
||||
|
||||
def find_mount_point(path):
|
||||
# Even if something's wrong, "/" is a mount point, so the loop will exit.
|
||||
# Use realpath in case it's a symlink
|
||||
path = op.realpath(path) # Required to avoid infinite loop
|
||||
while not op.ismount(path):
|
||||
path = op.join(*op.split(path)[:-1])
|
||||
path = op.split(path)[0]
|
||||
return path
|
||||
|
||||
def find_ext_volume_trash(volume_root):
|
||||
for candidate in EXTERNAL_CANDIDATES:
|
||||
candidate_path = op.join(volume_root, candidate)
|
||||
if op.exists(candidate_path):
|
||||
return candidate_path
|
||||
else:
|
||||
# Something's wrong here. Screw that, just create a .Trash folder
|
||||
trash_path = op.join(volume_root, '.Trash')
|
||||
os.mkdir(trash_path)
|
||||
return trash_path
|
||||
def find_ext_volume_global_trash(volume_root):
|
||||
# from [2] Trash directories (1) check for a .Trash dir with the right
|
||||
# permissions set.
|
||||
trash_dir = op.join(volume_root, TOPDIR_TRASH)
|
||||
if not op.exists(trash_dir):
|
||||
return None
|
||||
|
||||
def move_without_conflict(src, dst):
|
||||
filename = op.basename(src)
|
||||
destpath = op.join(dst, filename)
|
||||
counter = 0
|
||||
while op.exists(destpath):
|
||||
counter += 1
|
||||
base_name, ext = op.splitext(filename)
|
||||
new_filename = '{0} {1}{2}'.format(base_name, counter, ext)
|
||||
destpath = op.join(TRASH_PATH, new_filename)
|
||||
os.rename(src, destpath)
|
||||
mode = os.lstat(trash_dir).st_mode
|
||||
# vol/.Trash must be a directory, cannot be a symlink, and must have the
|
||||
# sticky bit set.
|
||||
if not op.isdir(trash_dir) or op.islink(trash_dir) or not (mode & stat.S_ISVTX):
|
||||
return None
|
||||
|
||||
trash_dir = op.join(trash_dir, text_type(uid).encode('ascii'))
|
||||
try:
|
||||
check_create(trash_dir)
|
||||
except OSError:
|
||||
return None
|
||||
return trash_dir
|
||||
|
||||
def find_ext_volume_fallback_trash(volume_root):
|
||||
# from [2] Trash directories (1) create a .Trash-$uid dir.
|
||||
trash_dir = op.join(volume_root, TOPDIR_FALLBACK)
|
||||
# Try to make the directory, if we can't the OSError exception will escape
|
||||
# be thrown out of send2trash.
|
||||
check_create(trash_dir)
|
||||
return trash_dir
|
||||
|
||||
def find_ext_volume_trash(volume_root):
|
||||
trash_dir = find_ext_volume_global_trash(volume_root)
|
||||
if trash_dir is None:
|
||||
trash_dir = find_ext_volume_fallback_trash(volume_root)
|
||||
return trash_dir
|
||||
|
||||
# Pull this out so it's easy to stub (to avoid stubbing lstat itself)
|
||||
def get_dev(path):
|
||||
return os.lstat(path).st_dev
|
||||
|
||||
def send2trash(path):
|
||||
if not isinstance(path, unicode):
|
||||
path = unicode(path, sys.getfilesystemencoding())
|
||||
try:
|
||||
move_without_conflict(path, TRASH_PATH)
|
||||
except OSError:
|
||||
# We're probably on an external volume
|
||||
mount_point = find_mount_point(path)
|
||||
dest_trash = find_ext_volume_trash(mount_point)
|
||||
move_without_conflict(path, dest_trash)
|
||||
if isinstance(path, text_type):
|
||||
path_b = fsencode(path)
|
||||
elif isinstance(path, bytes):
|
||||
path_b = path
|
||||
elif hasattr(path, '__fspath__'):
|
||||
# Python 3.6 PathLike protocol
|
||||
return send2trash(path.__fspath__())
|
||||
else:
|
||||
raise TypeError('str, bytes or PathLike expected, not %r' % type(path))
|
||||
|
||||
if not op.exists(path_b):
|
||||
raise OSError("File not found: %s" % path)
|
||||
# ...should check whether the user has the necessary permissions to delete
|
||||
# it, before starting the trashing operation itself. [2]
|
||||
if not os.access(path_b, os.W_OK):
|
||||
raise OSError("Permission denied: %s" % path)
|
||||
# if the file to be trashed is on the same device as HOMETRASH we
|
||||
# want to move it there.
|
||||
path_dev = get_dev(path_b)
|
||||
|
||||
# If XDG_DATA_HOME or HOMETRASH do not yet exist we need to stat the
|
||||
# home directory, and these paths will be created further on if needed.
|
||||
trash_dev = get_dev(op.expanduser(b'~'))
|
||||
|
||||
if path_dev == trash_dev:
|
||||
topdir = XDG_DATA_HOME
|
||||
dest_trash = HOMETRASH_B
|
||||
else:
|
||||
topdir = find_mount_point(path_b)
|
||||
trash_dev = get_dev(topdir)
|
||||
if trash_dev != path_dev:
|
||||
raise OSError("Couldn't find mount point for %s" % path)
|
||||
dest_trash = find_ext_volume_trash(topdir)
|
||||
trash_move(path_b, dest_trash, topdir)
|
||||
|
||||
@@ -1,15 +1,70 @@
|
||||
# Copyright 2010 Hardcoded Software (http://www.hardcoded.net)
|
||||
# Copyright 2017 Virgil Dupras
|
||||
|
||||
# This software is licensed under the "BSD" License as described in the "LICENSE" file,
|
||||
# which should be included with this package. The terms are also available at
|
||||
# This software is licensed under the "BSD" License as described in the "LICENSE" file,
|
||||
# which should be included with this package. The terms are also available at
|
||||
# http://www.hardcoded.net/licenses/bsd_license
|
||||
|
||||
from __future__ import unicode_literals
|
||||
|
||||
from ctypes import (windll, Structure, byref, c_uint,
|
||||
create_unicode_buffer, sizeof, addressof)
|
||||
from ctypes.wintypes import HWND, UINT, LPCWSTR, BOOL
|
||||
import os.path as op
|
||||
import _send2trash_win
|
||||
|
||||
from .compat import text_type
|
||||
|
||||
shell32 = windll.shell32
|
||||
SHFileOperationW = shell32.SHFileOperationW
|
||||
|
||||
class SHFILEOPSTRUCTW(Structure):
|
||||
_fields_ = [
|
||||
("hwnd", HWND),
|
||||
("wFunc", UINT),
|
||||
("pFrom", LPCWSTR),
|
||||
("pTo", LPCWSTR),
|
||||
("fFlags", c_uint),
|
||||
("fAnyOperationsAborted", BOOL),
|
||||
("hNameMappings", c_uint),
|
||||
("lpszProgressTitle", LPCWSTR),
|
||||
]
|
||||
|
||||
FO_MOVE = 1
|
||||
FO_COPY = 2
|
||||
FO_DELETE = 3
|
||||
FO_RENAME = 4
|
||||
|
||||
FOF_MULTIDESTFILES = 1
|
||||
FOF_SILENT = 4
|
||||
FOF_NOCONFIRMATION = 16
|
||||
FOF_ALLOWUNDO = 64
|
||||
FOF_NOERRORUI = 1024
|
||||
|
||||
def send2trash(path):
|
||||
if not isinstance(path, unicode):
|
||||
path = unicode(path, 'mbcs')
|
||||
if not isinstance(path, text_type):
|
||||
path = text_type(path, 'mbcs')
|
||||
if not op.isabs(path):
|
||||
path = op.abspath(path)
|
||||
_send2trash_win.send(path)
|
||||
fileop = SHFILEOPSTRUCTW()
|
||||
fileop.hwnd = 0
|
||||
fileop.wFunc = FO_DELETE
|
||||
# FIX: https://github.com/hsoft/send2trash/issues/17
|
||||
# Starting in python 3.6.3 it is no longer possible to use:
|
||||
# LPCWSTR(path + '\0') directly as embedded null characters are no longer
|
||||
# allowed in strings
|
||||
# Workaround
|
||||
# - create buffer of c_wchar[] (LPCWSTR is based on this type)
|
||||
# - buffer is two c_wchar characters longer (double null terminator)
|
||||
# - cast the address of the buffer to a LPCWSTR
|
||||
# NOTE: based on how python allocates memory for these types they should
|
||||
# always be zero, if this is ever not true we can go back to explicitly
|
||||
# setting the last two characters to null using buffer[index] = '\0'.
|
||||
buffer = create_unicode_buffer(path, len(path)+2)
|
||||
fileop.pFrom = LPCWSTR(addressof(buffer))
|
||||
fileop.pTo = None
|
||||
fileop.fFlags = FOF_ALLOWUNDO | FOF_NOCONFIRMATION | FOF_NOERRORUI | FOF_SILENT
|
||||
fileop.fAnyOperationsAborted = 0
|
||||
fileop.hNameMappings = 0
|
||||
fileop.lpszProgressTitle = None
|
||||
result = SHFileOperationW(byref(fileop))
|
||||
if result:
|
||||
raise WindowsError(None, None, path, result)
|
||||
|
||||
46
setup.py
46
setup.py
@@ -1,33 +1,33 @@
|
||||
import sys
|
||||
import os.path as op
|
||||
|
||||
from setuptools import setup
|
||||
from distutils.extension import Extension
|
||||
|
||||
exts = []
|
||||
CLASSIFIERS = [
|
||||
'Development Status :: 5 - Production/Stable',
|
||||
'Intended Audience :: Developers',
|
||||
'License :: OSI Approved :: BSD License',
|
||||
'Operating System :: MacOS :: MacOS X',
|
||||
'Operating System :: Microsoft :: Windows',
|
||||
'Operating System :: POSIX',
|
||||
'Programming Language :: Python :: 2.7',
|
||||
'Programming Language :: Python :: 3',
|
||||
'Programming Language :: Python :: 3.4',
|
||||
'Programming Language :: Python :: 3.5',
|
||||
'Programming Language :: Python :: 3.6',
|
||||
'Topic :: Desktop Environment :: File Managers',
|
||||
]
|
||||
|
||||
if sys.platform == 'darwin':
|
||||
exts.append(Extension(
|
||||
'_send2trash_osx',
|
||||
[op.join('modules', 'send2trash_osx.c')],
|
||||
extra_link_args=['-framework', 'CoreServices'],
|
||||
))
|
||||
if sys.platform == 'win32':
|
||||
exts.append(Extension(
|
||||
'_send2trash_win',
|
||||
[op.join('modules', 'send2trash_win.c')],
|
||||
extra_link_args = ['shell32.lib'],
|
||||
))
|
||||
LONG_DESCRIPTION = open('README.rst', 'rt').read() + '\n\n' + open('CHANGES.rst', 'rt').read()
|
||||
|
||||
setup(
|
||||
name='Send2Trash',
|
||||
version='1.0.0',
|
||||
author='Hardcoded Software',
|
||||
version='1.4.2',
|
||||
author='Virgil Dupras',
|
||||
author_email='hsoft@hardcoded.net',
|
||||
packages=['send2trash'],
|
||||
scripts=[],
|
||||
ext_modules = exts,
|
||||
url='http://hg.hardcoded.net/send2trash/',
|
||||
license='LICENSE',
|
||||
test_suite='tests',
|
||||
url='https://github.com/hsoft/send2trash',
|
||||
license='BSD License',
|
||||
description='Send file to trash natively under Mac OS X, Windows and Linux.',
|
||||
)
|
||||
long_description=LONG_DESCRIPTION,
|
||||
classifiers=CLASSIFIERS,
|
||||
)
|
||||
|
||||
0
tests/__init__.py
Normal file
0
tests/__init__.py
Normal file
170
tests/test_plat_other.py
Normal file
170
tests/test_plat_other.py
Normal file
@@ -0,0 +1,170 @@
|
||||
# encoding: utf-8
|
||||
import codecs
|
||||
import unittest
|
||||
import os
|
||||
from os import path as op
|
||||
import send2trash.plat_other
|
||||
from send2trash.plat_other import send2trash as s2t
|
||||
from send2trash.compat import PY3
|
||||
from configparser import ConfigParser
|
||||
from tempfile import mkdtemp, NamedTemporaryFile, mktemp
|
||||
import shutil
|
||||
import stat
|
||||
import sys
|
||||
# Could still use cleaning up. But no longer relies on ramfs.
|
||||
|
||||
HOMETRASH = send2trash.plat_other.HOMETRASH
|
||||
|
||||
def touch(path):
|
||||
with open(path, 'a'):
|
||||
os.utime(path, None)
|
||||
|
||||
class TestHomeTrash(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.file = NamedTemporaryFile(
|
||||
dir=op.expanduser("~"), prefix='send2trash_test', delete=False)
|
||||
|
||||
def test_trash(self):
|
||||
s2t(self.file.name)
|
||||
self.assertFalse(op.exists(self.file.name))
|
||||
|
||||
def tearDown(self):
|
||||
name = op.basename(self.file.name)
|
||||
os.remove(op.join(HOMETRASH, 'files', name))
|
||||
os.remove(op.join(HOMETRASH, 'info', name+'.trashinfo'))
|
||||
|
||||
|
||||
def _filesys_enc():
|
||||
enc = sys.getfilesystemencoding()
|
||||
# Get canonical name of codec
|
||||
return codecs.lookup(enc).name
|
||||
|
||||
@unittest.skipIf(_filesys_enc() == 'ascii', 'ASCII filesystem')
|
||||
class TestUnicodeTrash(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.name = u'send2trash_tést1'
|
||||
self.file = op.join(op.expanduser(b'~'), self.name.encode('utf-8'))
|
||||
touch(self.file)
|
||||
|
||||
def test_trash_bytes(self):
|
||||
s2t(self.file)
|
||||
assert not op.exists(self.file)
|
||||
|
||||
def test_trash_unicode(self):
|
||||
s2t(self.file.decode(sys.getfilesystemencoding()))
|
||||
assert not op.exists(self.file)
|
||||
|
||||
def tearDown(self):
|
||||
if op.exists(self.file):
|
||||
os.remove(self.file)
|
||||
|
||||
trash_file = op.join(HOMETRASH, 'files', self.name)
|
||||
if op.exists(trash_file):
|
||||
os.remove(trash_file)
|
||||
os.remove(op.join(HOMETRASH, 'info', self.name+'.trashinfo'))
|
||||
|
||||
#
|
||||
# Tests for files on some other volume than the user's home directory.
|
||||
#
|
||||
# What we need to stub:
|
||||
# * plat_other.get_dev (to make sure the file will not be on the home dir dev)
|
||||
# * os.path.ismount (to make our topdir look like a top dir)
|
||||
#
|
||||
class TestExtVol(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.trashTopdir = mkdtemp(prefix='s2t')
|
||||
if PY3:
|
||||
trashTopdir_b = os.fsencode(self.trashTopdir)
|
||||
else:
|
||||
trashTopdir_b = self.trashTopdir
|
||||
self.fileName = 'test.txt'
|
||||
self.filePath = op.join(self.trashTopdir, self.fileName)
|
||||
touch(self.filePath)
|
||||
|
||||
self.old_ismount = old_ismount = op.ismount
|
||||
self.old_getdev = send2trash.plat_other.get_dev
|
||||
def s_getdev(path):
|
||||
from send2trash.plat_other import is_parent
|
||||
st = os.lstat(path)
|
||||
if is_parent(self.trashTopdir, path):
|
||||
return 'dev'
|
||||
return st.st_dev
|
||||
def s_ismount(path):
|
||||
if op.realpath(path) in (op.realpath(self.trashTopdir), op.realpath(trashTopdir_b)):
|
||||
return True
|
||||
return old_ismount(path)
|
||||
|
||||
send2trash.plat_other.os.path.ismount = s_ismount
|
||||
send2trash.plat_other.get_dev = s_getdev
|
||||
|
||||
def tearDown(self):
|
||||
send2trash.plat_other.get_dev = self.old_getdev
|
||||
send2trash.plat_other.os.path.ismount = self.old_ismount
|
||||
shutil.rmtree(self.trashTopdir)
|
||||
|
||||
class TestTopdirTrash(TestExtVol):
|
||||
def setUp(self):
|
||||
TestExtVol.setUp(self)
|
||||
# Create a .Trash dir w/ a sticky bit
|
||||
self.trashDir = op.join(self.trashTopdir, '.Trash')
|
||||
os.mkdir(self.trashDir, 0o777|stat.S_ISVTX)
|
||||
|
||||
def test_trash(self):
|
||||
s2t(self.filePath)
|
||||
self.assertFalse(op.exists(self.filePath))
|
||||
self.assertTrue(op.exists(op.join(self.trashDir, str(os.getuid()), 'files', self.fileName)))
|
||||
self.assertTrue(op.exists(op.join(self.trashDir, str(os.getuid()), 'info', self.fileName + '.trashinfo')))
|
||||
# info relative path (if another test is added, with the same fileName/Path,
|
||||
# then it gets renamed etc.)
|
||||
cfg = ConfigParser()
|
||||
cfg.read(op.join(self.trashDir, str(os.getuid()), 'info', self.fileName + '.trashinfo'))
|
||||
self.assertEqual(self.fileName, cfg.get('Trash Info', 'Path', raw=True))
|
||||
|
||||
# Test .Trash-UID
|
||||
class TestTopdirTrashFallback(TestExtVol):
|
||||
def test_trash(self):
|
||||
touch(self.filePath)
|
||||
s2t(self.filePath)
|
||||
self.assertFalse(op.exists(self.filePath))
|
||||
self.assertTrue(op.exists(op.join(self.trashTopdir, '.Trash-' + str(os.getuid()), 'files', self.fileName)))
|
||||
|
||||
# Test failure
|
||||
class TestTopdirFailure(TestExtVol):
|
||||
def setUp(self):
|
||||
TestExtVol.setUp(self)
|
||||
os.chmod(self.trashTopdir, 0o500) # not writable to induce the exception
|
||||
|
||||
def test_trash(self):
|
||||
with self.assertRaises(OSError):
|
||||
s2t(self.filePath)
|
||||
self.assertTrue(op.exists(self.filePath))
|
||||
|
||||
def tearDown(self):
|
||||
os.chmod(self.trashTopdir, 0o700) # writable to allow deletion
|
||||
TestExtVol.tearDown(self)
|
||||
|
||||
# Make sure it will find the mount point properly for a file in a symlinked path
|
||||
class TestSymlink(TestExtVol):
|
||||
def setUp(self):
|
||||
TestExtVol.setUp(self)
|
||||
# Use mktemp (race conditioney but no symlink equivalent)
|
||||
# Since is_parent uses realpath(), and our getdev uses is_parent,
|
||||
# this should work
|
||||
self.slDir = mktemp(prefix='s2t', dir=op.expanduser('~'))
|
||||
|
||||
os.mkdir(op.join(self.trashTopdir, 'subdir'), 0o700)
|
||||
self.filePath = op.join(self.trashTopdir, 'subdir', self.fileName)
|
||||
touch(self.filePath)
|
||||
os.symlink(op.join(self.trashTopdir, 'subdir'), self.slDir)
|
||||
|
||||
def test_trash(self):
|
||||
s2t(op.join(self.slDir, self.fileName))
|
||||
self.assertFalse(op.exists(self.filePath))
|
||||
self.assertTrue(op.exists(op.join(self.trashTopdir, '.Trash-' + str(os.getuid()), 'files', self.fileName)))
|
||||
|
||||
def tearDown(self):
|
||||
os.remove(self.slDir)
|
||||
TestExtVol.tearDown(self)
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
Reference in New Issue
Block a user