├── recycle ├── __init__.py ├── move_to_trash.py ├── permanently_delete.py ├── config.py ├── recover_from_trash.py ├── trash_tree.py ├── init_env.py └── lib.py ├── README.rst ├── .gitignore ├── setup.py ├── README_CN.md ├── README.md └── LICENSE /recycle/__init__.py: -------------------------------------------------------------------------------- 1 | from . import * 2 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | https://github.com/twfb/recycle/ 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | build/ 2 | dist/ 3 | py_recycle.egg-info/ 4 | .history/ 5 | -------------------------------------------------------------------------------- /recycle/move_to_trash.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | import os 4 | import json 5 | 6 | from recycle.config import TRASH_PATH 7 | from recycle.lib import ( 8 | mkdir, 9 | operations, 10 | search_files, 11 | generate_trash_file_name, 12 | execute_move, 13 | directory_exists, 14 | ) 15 | 16 | 17 | def move_to_trash(trash_dir, file_regex): 18 | if not directory_exists(trash_dir): 19 | return 20 | 21 | for del_file in search_files(trash_dir, file_regex): 22 | absolute_trash_file_dir = TRASH_PATH + del_file 23 | mkdir(absolute_trash_file_dir) 24 | trash_file = os.path.join( 25 | absolute_trash_file_dir, generate_trash_file_name(del_file) 26 | ) 27 | execute_move(del_file, trash_file) 28 | 29 | 30 | def main(): 31 | for parent_dir, file_regex, _, _ in operations(): 32 | move_to_trash(parent_dir, file_regex) 33 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | 3 | setup( 4 | name="py-recycle", 5 | version="1.3.6", 6 | description=("Recycle for linux"), 7 | long_description=open("README.rst").read(), 8 | author="twfb", 9 | author_email="twfb@hotmail.com", 10 | maintainer="twfb", 11 | maintainer_email="twfb@hotmail.com", 12 | license="GPLv3", 13 | packages=find_packages(), 14 | platforms=["all"], 15 | include_package_data=True, 16 | url="https://github.com/twfb/recycle", 17 | classifiers=[ 18 | "Development Status :: 4 - Beta", 19 | "Operating System :: OS Independent", 20 | "Intended Audience :: Developers", 21 | "License :: OSI Approved :: BSD License", 22 | "Programming Language :: Python", 23 | "Programming Language :: Python :: Implementation", 24 | "Programming Language :: Python :: 2", 25 | "Programming Language :: Python :: 2.7", 26 | "Programming Language :: Python :: 3", 27 | "Programming Language :: Python :: 3.4", 28 | "Programming Language :: Python :: 3.5", 29 | "Programming Language :: Python :: 3.6", 30 | "Programming Language :: Python :: 3.7", 31 | "Programming Language :: Python :: 3.8", 32 | "Programming Language :: Python :: 3.9", 33 | "Topic :: Software Development :: Libraries", 34 | ], 35 | entry_points={ 36 | "console_scripts": [ 37 | "del=recycle.move_to_trash:main", 38 | "undel=recycle.recover_from_trash:main", 39 | "tt=recycle.trash_tree:main", 40 | "recycle_init=recycle.init_env:main", 41 | "pdel=recycle.permanently_delete:main", 42 | ], 43 | }, 44 | ), 45 | -------------------------------------------------------------------------------- /recycle/permanently_delete.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | import os 4 | import re 5 | 6 | from recycle.config import TRASH_PATH, TRASH_REGEX 7 | from recycle.lib import ( 8 | input_yes, 9 | operations, 10 | search_files, 11 | execute_delete, 12 | directory_exists, 13 | remove_empty_dir, 14 | get_colorful_str, 15 | remove_trash_path, 16 | ) 17 | 18 | 19 | def delete_by_id(absolute_file): 20 | return execute_delete(absolute_file) 21 | 22 | 23 | def batch_delete(files): 24 | for i in files: 25 | execute_delete(i) 26 | remove_empty_dir(i) 27 | 28 | 29 | def delete_by_regrex(absolute_file, absolute_dir, file_regex, reverse): 30 | deleted_files = [] 31 | for absolute_trash_file_dir in search_files(absolute_dir, file_regex): 32 | if not directory_exists(absolute_trash_file_dir): 33 | return 34 | for absolute_sub_file_path in search_files( 35 | absolute_trash_file_dir, TRASH_REGEX 36 | ): 37 | deleted_files.append(absolute_sub_file_path) 38 | if deleted_files and permanently_delete_ask(absolute_file): 39 | batch_delete(deleted_files) 40 | 41 | 42 | def permanently_delete_ask(absolute_file): 43 | return input_yes( 44 | "\tPermanently delete {} ? [N/y] ".format( 45 | get_colorful_str(absolute_file.replace("\.", ""), color_code="red", end="") 46 | ) 47 | ) 48 | 49 | 50 | def permanently_delete(trash_dir, file_regex, reverse, raw): 51 | if trash_dir.startswith(TRASH_PATH): 52 | relative_dir = remove_trash_path(trash_dir).strip("/") 53 | else: 54 | relative_dir = trash_dir.strip("/") 55 | absolute_dir = os.path.join(TRASH_PATH, relative_dir) 56 | if not directory_exists(absolute_dir): 57 | if directory_exists(raw): 58 | absolute_dir = raw 59 | else: 60 | return 61 | absolute_file = os.path.join(absolute_dir, file_regex) 62 | if re.match(TRASH_REGEX, file_regex) and permanently_delete_ask(absolute_file): 63 | return delete_by_id(absolute_file) 64 | delete_by_regrex(absolute_file, absolute_dir, file_regex, reverse) 65 | return remove_empty_dir(absolute_dir) 66 | 67 | 68 | def main(): 69 | for parent_dir, file_regex, reverse, raw in operations(): 70 | permanently_delete(parent_dir, file_regex, reverse, raw) 71 | -------------------------------------------------------------------------------- /recycle/config.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | import json 4 | import os 5 | import sys 6 | 7 | HOME = os.path.expanduser("~") 8 | INIT_TRASH_PATH = HOME + "/.Trash" 9 | TRASH_DATETIME_FORMAT = "%Y-%m-%d_%H:%M:%S%f_" 10 | TRASH_REGEX = "\d{4}-\d{2}-\d{2}_\d{2}:\d{2}:\d{8}_[0-9\.]+[A-Z]?" 11 | CONFIG_PATH = HOME + "/.py_recycle.json" 12 | if not os.path.isfile(CONFIG_PATH): 13 | open(CONFIG_PATH, "w").write("{}") 14 | config = json.loads(open(CONFIG_PATH).read()) 15 | 16 | if sys.version_info[0] >= 3: 17 | unicode = str 18 | 19 | for k, v in config.items(): 20 | if isinstance(v, unicode): 21 | config[k] = str(v) 22 | elif isinstance(v, list): 23 | for ji, jv in enumerate(v): 24 | if isinstance(jv, unicode): 25 | config[k][ji] = str(jv) 26 | elif isinstance(v, dict): 27 | for hk, hv in v.items(): 28 | if isinstance(hv, unicode): 29 | config[k][hk] = str(hv) 30 | 31 | 32 | EMOJIS = {"file": "📄", "directory": "📁"} 33 | COLORS = { 34 | "black": "0;30", 35 | "red": "0;31", 36 | "green": "0;32", 37 | "orange": "0;33", 38 | "blue": "0;34", 39 | "magenta": "0;35", 40 | "cyan": "0;36", 41 | "light_gray": "0;37", 42 | "dark_gray": "1;30", 43 | "light_red": "1;31", 44 | "light_green": "1;32", 45 | "yellow": "1;33", 46 | "light_blue": "1;34", 47 | "light_purple": "1;35", 48 | "light_cyan": "1;36", 49 | "white": "1;37", 50 | } 51 | 52 | FILE_SIZE_COLORS = { 53 | "file size unit": [ 54 | "file size < 10unit", 55 | "file size < 100unit", 56 | "file size < 1000unit", 57 | "file size < 10000unit", 58 | ], 59 | "choice of color": list(COLORS.keys()), 60 | "": ["light_gray"] * 4, 61 | "b": ["light_gray"] * 4, 62 | "B": ["light_gray"] * 4, 63 | "K": ["light_gray"] * 3 + ["cyan"], 64 | "M": ["cyan", "cyan", "light_cyan", "orange"], 65 | "G": ["orange", "orange", "yellow", "magenta"], 66 | "T": ["magenta", "magenta", "light_purple", "red"], 67 | "P": ["red", "red", "light_red", "light_red"], 68 | } 69 | # User Config 70 | ENABLE_EMOJI = config.get("ENABLE_EMOJI", True) 71 | VERBOSE = config.get("VERBOSE", True) 72 | ENABLE_COLOR = config.get("ENABLE_COLOR", True) 73 | TREE_ALL_DIRECTORY_SIZE = config.get("TREE_ALL_DIRECTORY_SIZE", True) 74 | TRASH_PATH = (config.get("TRASH_PATH") or INIT_TRASH_PATH).rstrip("/") 75 | FILE_SIZE_COLORS = config.get("FILE_SIZE_COLORS") or FILE_SIZE_COLORS 76 | -------------------------------------------------------------------------------- /recycle/recover_from_trash.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | import os 4 | import re 5 | 6 | from recycle.config import TRASH_PATH, TRASH_REGEX 7 | from recycle.lib import ( 8 | mkdir, 9 | my_print, 10 | operations, 11 | search_files, 12 | replace_file, 13 | execute_move, 14 | directory_exists, 15 | remove_trash_path, 16 | remove_empty_dir, 17 | ) 18 | 19 | 20 | def recover_by_id(file_path, recover_path, copy=False): 21 | if replace_file(recover_path): 22 | mkdir(os.path.dirname(recover_path)) 23 | execute_move(file_path, recover_path, copy) 24 | return remove_empty_dir(os.path.dirname(file_path)) 25 | 26 | 27 | def recover_by_regrex(absolute_dir, file_regex, recover_path, reverse): 28 | for absolute_trash_file_dir in search_files(absolute_dir, file_regex): 29 | recover_trash_file_dir = remove_trash_path(absolute_trash_file_dir) 30 | if not directory_exists(absolute_trash_file_dir): 31 | return 32 | trash_files_list = search_files(absolute_trash_file_dir, TRASH_REGEX) 33 | for file_path in sorted(trash_files_list, reverse=reverse): 34 | recover_by_id(file_path, recover_trash_file_dir) 35 | break 36 | remove_empty_dir(absolute_trash_file_dir) 37 | 38 | 39 | def recover_from_trash(trash_dir, file_regex, reverse, raw): 40 | relative_dir = remove_trash_path(trash_dir) 41 | trash_id_in_dir = re.search(TRASH_REGEX, trash_dir) 42 | is_trash_id = re.match(TRASH_REGEX, file_regex) 43 | relative_dir = trash_dir.strip("/") 44 | absolute_dir = os.path.join(TRASH_PATH, relative_dir) 45 | recover_path = "/" + relative_dir 46 | 47 | if not directory_exists(absolute_dir): 48 | if directory_exists(raw): 49 | absolute_dir = raw 50 | else: 51 | return 52 | current_dir = os.getcwd() 53 | if is_trash_id: 54 | recover_by_id(os.path.join(absolute_dir, file_regex), recover_path) 55 | if trash_dir == current_dir: 56 | my_print("\nPlease run: \n\n\tcd ..;cd -") 57 | return 58 | elif trash_id_in_dir: 59 | recover_path = os.path.join(re.sub(TRASH_REGEX, "", recover_path), file_regex) 60 | recover_by_id(os.path.join(absolute_dir, file_regex), recover_path, copy=True) 61 | if trash_dir == current_dir: 62 | my_print("\nPlease run: \n\n\tcd ..;cd -") 63 | return 64 | recover_by_regrex(absolute_dir, file_regex, recover_path, reverse) 65 | 66 | 67 | def main(): 68 | for parent_dir, file_regex, reverse, raw in operations(): 69 | recover_from_trash(parent_dir, file_regex, reverse, raw) 70 | -------------------------------------------------------------------------------- /recycle/trash_tree.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | import os 4 | import re 5 | import sys 6 | 7 | from recycle.config import ( 8 | TRASH_PATH, 9 | TRASH_REGEX, 10 | ENABLE_EMOJI, 11 | EMOJIS, 12 | TREE_ALL_DIRECTORY_SIZE, 13 | ) 14 | 15 | from recycle.lib import ( 16 | my_print, 17 | directory_exists, 18 | operations, 19 | search_files, 20 | get_current_path, 21 | get_path_size_str, 22 | get_size_color_code, 23 | ) 24 | 25 | 26 | def print_file(file_name): 27 | if ENABLE_EMOJI: 28 | my_print(EMOJIS["file"], end=" ") 29 | color_code = get_size_color_code(file_name.split("_")[-1]) 30 | my_print(file_name, color_code=color_code) 31 | 32 | 33 | def print_directory(directory_name, directory_path, is_trash=False, is_header=False): 34 | if is_trash: 35 | if ENABLE_EMOJI: 36 | my_print(EMOJIS["directory"], end=" ") 37 | color_code = get_size_color_code(directory_name.split("_")[-1]) 38 | my_print(directory_name, color_code=color_code) 39 | 40 | elif is_header: 41 | size_str = get_path_size_str(directory_path) 42 | my_print( 43 | "{} [{}]".format(directory_name, size_str), 44 | color_code=get_size_color_code(size_str), 45 | ) 46 | elif TREE_ALL_DIRECTORY_SIZE: 47 | size_str = get_path_size_str(directory_path) 48 | my_print( 49 | "{} [{}]".format(directory_name, size_str), 50 | color_code=get_size_color_code(size_str), 51 | ) 52 | else: 53 | my_print(directory_name) 54 | 55 | 56 | def print_branch(file_name, file_path, is_last_one, parent_str, stop_regex): 57 | stop_tree = re.match(stop_regex, file_name) if stop_regex else False 58 | tmp_str = parent_str 59 | 60 | if is_last_one: 61 | header = "└── " 62 | parent_str += " " 63 | else: 64 | header = "├── " 65 | parent_str += "│ " 66 | try: 67 | sys.stdout.write(tmp_str + header) 68 | except: 69 | pass 70 | 71 | if not os.path.isdir(file_path): 72 | print_file(file_name) 73 | return 74 | 75 | if not stop_tree: 76 | print_directory(file_name, file_path) 77 | return print_tree(file_path, parent_str=parent_str, stop_regex=stop_regex) 78 | 79 | print_directory(file_name, file_path, True) 80 | 81 | 82 | def print_tree(directory, stop_regex=None, parent_str="", first_print_regex=True): 83 | if first_print_regex and stop_regex: 84 | files = sorted( 85 | os.listdir(directory), 86 | key=lambda x: x if re.match(stop_regex, x) else "X" + x, 87 | ) 88 | else: 89 | files = sorted(os.listdir(directory)) 90 | 91 | files_number = len(files) 92 | for i in range(files_number): 93 | file_name = files[i] 94 | file_path = os.path.join(directory, file_name) 95 | is_last_one = i == files_number - 1 96 | print_branch(file_name, file_path, is_last_one, parent_str, stop_regex) 97 | 98 | 99 | def main(): 100 | tree_pwd = True 101 | for parent_dir, file_regex, _, raw in operations(): 102 | tree_pwd = False 103 | if not parent_dir.startswith(TRASH_PATH): 104 | parent_dir = TRASH_PATH + parent_dir 105 | for file_path in search_files(parent_dir, file_regex) or search_files( 106 | raw, file_regex 107 | ): 108 | if os.path.exists(file_path): 109 | print_directory(file_path, file_path, is_header=True) 110 | if os.path.isdir(file_path): 111 | print_tree(file_path, stop_regex=TRASH_REGEX) 112 | my_print("\n") 113 | if tree_pwd: 114 | directory = get_current_path() 115 | if not directory.startswith(TRASH_PATH): 116 | directory = TRASH_PATH + directory 117 | 118 | if directory_exists(directory): 119 | print_directory(directory, directory, is_header=True) 120 | print_tree(directory, stop_regex=TRASH_REGEX) 121 | -------------------------------------------------------------------------------- /README_CN.md: -------------------------------------------------------------------------------- 1 | # py-recycle 2 | > Linux 垃圾回收站 3 | 4 | ## 截屏 5 | [![asciicast](https://asciinema.org/a/435392.svg)](https://asciinema.org/a/435392) 6 | 7 | 8 | ## 用法 9 | - 将文件移动到回收站: `del file_path` 10 | - 将文件从回收站恢复: `undel file_path` or `undel trash_path` 11 | - 永久删除垃圾文件: `pdel trash_file` 12 | - 打印回收站文件树: `tt` 13 | - 打印回收站文件树调用`less`显示: `tl` 14 | - 示例 15 | - `del ~/a`, `del /root/a`, `del a`, `del \^a`, `del '^a'`, `del 'a/*/*'` 16 | - `undel ~/a`, `undel /root/a`, `undel a`, `undel /root/.Trash/a`, `del 'a/*/*'` 17 | - `pdel ~/a`, `pdel /root/a`, `pdel a`, `pdel /root/.Trash/a`, `pdel 'a/*/*'`, `pdel '/tmp/*'` 18 | - `tt`, `tt ~`, `tt '*/*'` 19 | - `tl`, `tl ~`, `tl '*/*'` 20 | 21 | ## 注意 22 | - 使用`undel`, `pdel`, `tt`, `tl`时按下tab后命令行提示的文件列表为**当前路径被删除的文件**和**回收站根路径被删除的文件** 23 | 24 | ```shell 25 | $ pwd 26 | /test 27 | $ mkdir dir /dir /dir2 28 | $ del dir /dir /dir2 29 | mkdir -p /root/.Trash/test/dir 30 | mv /test/dir /root/.Trash/test/dir/2022-09-02_01:39:06704016_4.0K 31 | mkdir -p /root/.Trash/dir 32 | mv /dir /root/.Trash/dir/2022-09-02_01:39:06713729_4.0K 33 | mkdir -p /root/.Trash/dir2 34 | mv /dir2 /root/.Trash/dir2/2022-09-02_01:39:06719008_4.0K 35 | 36 | $ pdel 37 | dir/ dir2/ etc/ home/ mnt/ root/ usr/ 38 | 39 | $ pdel dir 40 | Permanently delete /root/.Trash/test/dir ? [N/y] y 41 | rm -rf /root/.Trash/test/dir/2022-09-02_01:22:26772094_4.0K 42 | rmdir /root/.Trash/test/dir 43 | rmdir /root/.Trash/test 44 | 45 | $ pdel dir 46 | Permanently delete /root/.Trash/dir ? [N/y] y 47 | rm -rf /root/.Trash/dir/2022-09-02_01:22:29299637_4.0K 48 | rmdir /root/.Trash/dir 49 | 50 | $ pdel /dir2 51 | Permanently delete /root/.Trash/dir2 ? [N/y] y 52 | rm -rf /root/.Trash/dir2/2022-09-02_01:39:06719008_4.0K 53 | rmdir /root/.Trash/dir2 54 | ``` 55 | 56 | ## 安装 57 | 1. `pip install py-recycle` 58 | 2. `recycle_init` 59 | - 如果你的`PATH`中没有Python脚本目录, 执行 `/usr/local/bin/recycle_init 2&> /dev/null || ~/.local/bin/recycle_init` 60 | 61 | ## 配置 62 | - `VREBOSE`: 是否显示具体操作 63 | - `ENABLE_EMOJI`: 是否启用表情 64 | - `ENABLE_COLOR`: 是否启用颜色 65 | - `TREE_ALL_DIRECTORY_SIZE`: 是否打印所有文件大小 66 | - `TRASH_PATH`: 回收站绝对路径 67 | - `FILE_SIZE_COLORS`: 自定义文件大小单位的颜色 68 | 69 | 例: 70 | 71 | `vim ~/.py_recycle.json` 72 | 73 | ```Json 74 | { 75 | "VREBOSE": true, 76 | "ENABLE_EMOJI": true, 77 | "ENABLE_COLOR": true, 78 | "TREE_ALL_DIRECTORY_SIZE": false, 79 | "TRASH_PATH": "/root/.Trash", 80 | "FILE_SIZE_COLORS": { 81 | "文件大小单位": [ 82 | "文件大小<10单位", 83 | "文件大小<100单位", 84 | "文件大小<1000单位", 85 | "文件大小<10000单位" 86 | ], 87 | "可选颜色": [ 88 | "black", 89 | "red", 90 | "green", 91 | "orange", 92 | "blue", 93 | "magenta", 94 | "cyan", 95 | "light_gray", 96 | "dark_gray", 97 | "light_red", 98 | "light_green", 99 | "yellow", 100 | "light_blue", 101 | "light_purple", 102 | "light_cyan", 103 | "white" 104 | ], 105 | "": [ 106 | "light_gray", 107 | "light_gray", 108 | "light_gray", 109 | "light_gray" 110 | ], 111 | "b": [ 112 | "light_gray", 113 | "light_gray", 114 | "light_gray", 115 | "light_gray" 116 | ], 117 | "B": [ 118 | "light_gray", 119 | "light_gray", 120 | "light_gray", 121 | "light_gray" 122 | ], 123 | "K": [ 124 | "light_gray", 125 | "light_gray", 126 | "light_gray", 127 | "cyan" 128 | ], 129 | "M": [ 130 | "cyan", 131 | "cyan", 132 | "light_cyan", 133 | "orange" 134 | ], 135 | "G": [ 136 | "orange", 137 | "orange", 138 | "yellow", 139 | "magenta" 140 | ], 141 | "T": [ 142 | "magenta", 143 | "magenta", 144 | "light_purple", 145 | "red" 146 | ], 147 | "P": [ 148 | "red", 149 | "red", 150 | "light_red", 151 | "light_red" 152 | ] 153 | } 154 | } 155 | ``` 156 | 157 | ### TODO 158 | - [X] 根据垃圾文件大小显示不同颜色 159 | - [ ] 文件夹路径支持正则, 'del /\d+/a.*?' 160 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # py-recycle 2 | > Recycle Bin For Linux 3 | 4 | [中文](./README_CN.md) 5 | 6 | ## Screenshot 7 | [![asciicast](https://asciinema.org/a/435392.svg)](https://asciinema.org/a/435392) 8 | 9 | 10 | ## Usage 11 | - move file to trash directory: `del file_path` 12 | - recover file from trash directory: `undel file_path` or `undel trash_path` 13 | - permanently delete file: `pdel trash_file` 14 | - print trash tree: `tt` 15 | - print trash tree with `less`: `tl` 16 | - example 17 | - `del ~/a`, `del /root/a`, `del a`, `del \^a`, `del '^a'`, `del 'a/*/*'` 18 | - `undel ~/a`, `undel /root/a`, `undel a`, `undel /root/.Trash/a`, `del 'a/*/*'` 19 | - `pdel ~/a`, `pdel /root/a`, `pdel a`, `pdel /root/.Trash/a`, `pdel 'a/*/*'`, `pdel '/tmp/*'` 20 | - `tt`, `tt ~`, `tl '*/*'` 21 | - `tl`, `tl ~`, `tl '*/*'` 22 | 23 | ## Notice 24 | - Using the `undel`, `pdel`, `tt`, `tl` command prompt when pressing tab lists the files prompted for **current path deleted files** and **Recycle Bin root path deleted files** 25 | ```shell 26 | $ pwd 27 | /test 28 | $ mkdir dir /dir /dir2 29 | $ del dir /dir /dir2 30 | mkdir -p /root/.Trash/test/dir 31 | mv /test/dir /root/.Trash/test/dir/2022-09-02_01:39:06704016_4.0K 32 | mkdir -p /root/.Trash/dir 33 | mv /dir /root/.Trash/dir/2022-09-02_01:39:06713729_4.0K 34 | mkdir -p /root/.Trash/dir2 35 | mv /dir2 /root/.Trash/dir2/2022-09-02_01:39:06719008_4.0K 36 | 37 | $ pdel 38 | dir/ dir2/ etc/ home/ mnt/ root/ usr/ 39 | 40 | $ pdel dir 41 | Permanently delete /root/.Trash/test/dir ? [N/y] y 42 | rm -rf /root/.Trash/test/dir/2022-09-02_01:22:26772094_4.0K 43 | rmdir /root/.Trash/test/dir 44 | rmdir /root/.Trash/test 45 | 46 | $ pdel dir 47 | Permanently delete /root/.Trash/dir ? [N/y] y 48 | rm -rf /root/.Trash/dir/2022-09-02_01:22:29299637_4.0K 49 | rmdir /root/.Trash/dir 50 | 51 | $ pdel /dir2 52 | Permanently delete /root/.Trash/dir2 ? [N/y] y 53 | rm -rf /root/.Trash/dir2/2022-09-02_01:39:06719008_4.0K 54 | rmdir /root/.Trash/dir2 55 | ``` 56 | 57 | ## Installation 58 | 1. `pip install py-recycle` 59 | 2. `recycle_init` 60 | - If you did not add python script location to `PATH`, execute `/usr/local/bin/recycle_init 2&> /dev/null || ~/.local/bin/recycle_init` 61 | 62 | ## Configuration 63 | - `VERBOSE`: Show operations 64 | - `ENABLE_EMOJI`: Enable emoji 65 | - `ENABLE_COLOR`: Enable color 66 | - `TREE_ALL_DIRECTORY_SIZE`: Print all file or directory size 67 | - `TRASH_PATH`: Recycle bin absolute path 68 | - `FILE_SIZE_COLORS`: Customize the color of file size units 69 | 70 | Example: 71 | 72 | `vim ~/.py_recycle.json` 73 | 74 | ```Json 75 | { 76 | "VERBOSE": true, 77 | "ENABLE_EMOJI": true, 78 | "ENABLE_COLOR": true, 79 | "TREE_ALL_DIRECTORY_SIZE": false, 80 | "TRASH_PATH": "/root/.Trash", 81 | "FILE_SIZE_COLORS": { 82 | "file size unit": [ 83 | "file size < 10unit", 84 | "file size < 100unit", 85 | "file size < 1000unit", 86 | "file size < 10000unit" 87 | ], 88 | "choice of color": [ 89 | "black", 90 | "red", 91 | "green", 92 | "orange", 93 | "blue", 94 | "magenta", 95 | "cyan", 96 | "light_gray", 97 | "dark_gray", 98 | "light_red", 99 | "light_green", 100 | "yellow", 101 | "light_blue", 102 | "light_purple", 103 | "light_cyan", 104 | "white" 105 | ], 106 | "": [ 107 | "light_gray", 108 | "light_gray", 109 | "light_gray", 110 | "light_gray" 111 | ], 112 | "b": [ 113 | "light_gray", 114 | "light_gray", 115 | "light_gray", 116 | "light_gray" 117 | ], 118 | "B": [ 119 | "light_gray", 120 | "light_gray", 121 | "light_gray", 122 | "light_gray" 123 | ], 124 | "K": [ 125 | "light_gray", 126 | "light_gray", 127 | "light_gray", 128 | "cyan" 129 | ], 130 | "M": [ 131 | "cyan", 132 | "cyan", 133 | "light_cyan", 134 | "orange" 135 | ], 136 | "G": [ 137 | "orange", 138 | "orange", 139 | "yellow", 140 | "magenta" 141 | ], 142 | "T": [ 143 | "magenta", 144 | "magenta", 145 | "light_purple", 146 | "red" 147 | ], 148 | "P": [ 149 | "red", 150 | "red", 151 | "light_red", 152 | "light_red" 153 | ] 154 | } 155 | } 156 | ``` 157 | 158 | ### TODO 159 | - [X] show different color by trash file size 160 | - [ ] folder path support regex, 'del /\d+/a.*?' 161 | -------------------------------------------------------------------------------- /recycle/init_env.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | import json 4 | import os 5 | import sys 6 | 7 | from recycle.lib import my_print, my_input, mkdir 8 | from recycle.config import ( 9 | CONFIG_PATH, 10 | HOME, 11 | ENABLE_EMOJI, 12 | VERBOSE, 13 | ENABLE_COLOR, 14 | TREE_ALL_DIRECTORY_SIZE, 15 | TRASH_PATH, 16 | FILE_SIZE_COLORS, 17 | ) 18 | 19 | zsh_config = """# py-recycle config start 20 | # Don't put your config inside "# py-recycle config start" and "# py-recycle config end"! 21 | # Else it will be DELETE! 22 | autoload -Uz compinit 23 | compinit 24 | compdef '_files -W "`pwd`"' del 25 | compdef '_files -g ".*" -W "({path}`pwd` {path})"' undel 26 | compdef '_files -g ".*" -W "({path}`pwd` {path})"' pdel 27 | compdef '_files -g ".*" -W "({path}`pwd` {path})"' tt 28 | alias tl='tl(){{ tt $1 | less -r }};tl' 29 | compdef tl='tt' 30 | setopt complete_aliases 31 | # py-recycle config end 32 | """.format( 33 | path=TRASH_PATH 34 | ) 35 | 36 | bash_config = """# py-recycle config start 37 | # Don't put your config inside "# py-recycle config start" and "# py-recycle config end"! 38 | # Else it will be DELETE! 39 | _undel() {{ 40 | local trash_home="{}" 41 | local current_path=`pwd` 42 | local current_arg="${{COMP_WORDS[COMP_CWORD]}}" 43 | local trash_dir=$trash_home$current_path/${{COMP_LINE:6:999}} 44 | local IFS=$'\t\n' 45 | 46 | if [[ $current_arg =~ ^/ ]] ; then 47 | # /a/b/c 48 | return 0 49 | elif [[ $current_path =~ $trash_home ]] ; then 50 | # in {} 51 | return 0 52 | elif [[ ! -d $trash_dir ]] ; then 53 | # {}`pwd` don't exists 54 | return 0 55 | elif [[ -d $trash_dir ]] ; then 56 | COMPREPLY=( $(compgen -W "`ls -a $trash_dir|grep -Pv '^\.{{1,2}}$'`" -- ${{current_arg}}) ) 57 | return 0 58 | fi 59 | }} 60 | 61 | complete -o filenames -o dirnames -o default -F _undel undel 62 | complete -o filenames -o dirnames -o default -F _undel pdel 63 | complete -o filenames -o dirnames -o default -F _undel tt 64 | alias tl='tl(){{ tt $1 | less -r }};tl' 65 | # py-recycle config end 66 | """.format( 67 | TRASH_PATH, TRASH_PATH, TRASH_PATH 68 | ) 69 | 70 | shell_config = {"zsh": zsh_config, "bash": bash_config} 71 | 72 | 73 | def install(shell, path): 74 | shellrc_path = "{}/.{}rc".format(HOME, shell) 75 | 76 | if not os.path.exists("/bin/" + shell): 77 | return my_print("your don't have {}, skip it".format(shell)) 78 | config_info = "" 79 | config_info_bp = "" 80 | if os.path.isfile(shellrc_path): 81 | config_info = open(shellrc_path, "r").read() 82 | config_info_bp = config_info 83 | if "# py-recycle config start" in config_info: 84 | config_info = config_info.split("\n") 85 | config_info = "\n".join( 86 | config_info[0 : config_info.index("# py-recycle config start")] 87 | + config_info[config_info.index("# py-recycle config end") + 1 :] 88 | ) 89 | try: 90 | open(shellrc_path, "w").write(config_info + shell_config[shell]) 91 | my_print("Installed in {}, enjoy it :)".format(shellrc_path)) 92 | except: 93 | open(shellrc_path + ".old", "w").write(config_info_bp) 94 | my_print( 95 | "Install Failed in {}, old config file in {}.".format( 96 | shellrc_path, shellrc_path + ".old" 97 | ) 98 | ) 99 | 100 | if not path: 101 | return 102 | 103 | path = "export PATH={}\n".format(path) 104 | if path in open(shellrc_path).readlines(): 105 | return 106 | my_print('Write "{}" in {}'.format(path.strip(), shellrc_path)) 107 | open(shellrc_path, "a+").write(path) 108 | 109 | 110 | def main(): 111 | scripts_dir_path = os.path.dirname(sys.argv[0]) 112 | if scripts_dir_path in os.getenv("PATH"): 113 | path = None 114 | elif ( 115 | "n" 116 | in my_input( 117 | 'Add "{}" to your PATH, to enable it?[Y/n]'.format(scripts_dir_path) 118 | ).lower() 119 | ): 120 | path = None 121 | else: 122 | path = "{}:$PATH".format(scripts_dir_path) 123 | 124 | install("zsh", path) 125 | install("bash", path) 126 | 127 | if not os.path.exists(TRASH_PATH): 128 | mkdir(TRASH_PATH) 129 | open(CONFIG_PATH, "w").write( 130 | json.dumps( 131 | dict( 132 | ENABLE_EMOJI=ENABLE_EMOJI, 133 | VERBOSE=VERBOSE, 134 | ENABLE_COLOR=ENABLE_COLOR, 135 | TREE_ALL_DIRECTORY_SIZE=TREE_ALL_DIRECTORY_SIZE, 136 | TRASH_PATH=TRASH_PATH, 137 | FILE_SIZE_COLORS=FILE_SIZE_COLORS, 138 | ), 139 | indent=4, 140 | ) 141 | ) 142 | current_shell = os.getenv("SHELL").split("/")[-1] 143 | my_print("\n") 144 | if current_shell in ["bash", "zsh"]: 145 | command = "source ~/.{}rc".format(current_shell) 146 | my_print('\tPlease Execute "{}"'.format(command)) 147 | else: 148 | my_print( 149 | '\tSorry, detect current shell is "{}", recycle onle support "zsh" and "bash"'.format( 150 | current_shell 151 | ) 152 | ) 153 | my_print( 154 | '\tYou can manually execute "source ~/.zshrc" or "source ~/.bashrc" to config zsh or bash' 155 | ) 156 | my_print("\n") 157 | -------------------------------------------------------------------------------- /recycle/lib.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | import os 4 | import re 5 | import sys 6 | import datetime 7 | import subprocess 8 | 9 | from glob import glob 10 | from recycle.config import ( 11 | TRASH_PATH, 12 | TRASH_DATETIME_FORMAT, 13 | FILE_SIZE_COLORS, 14 | ENABLE_COLOR, 15 | COLORS, 16 | VERBOSE, 17 | ) 18 | 19 | _special_chars_map = {i: "\\" + chr(i) for i in b"()[]{}?*+-|^$\\.&~# \t\n\r\v\f\"'<>`"} 20 | 21 | 22 | def escape(pattern): 23 | if isinstance(pattern, str): 24 | return pattern.translate(_special_chars_map) 25 | else: 26 | pattern = str(pattern, "latin1") 27 | return pattern.translate(_special_chars_map).encode("latin1") 28 | 29 | 30 | def remove_trash_path(trash_file_path): 31 | if trash_file_path.startswith(TRASH_PATH): 32 | return trash_file_path[len(TRASH_PATH) :] 33 | return trash_file_path 34 | 35 | 36 | def mkdir(path): 37 | if os.path.isfile(path): 38 | my_print( 39 | "\t{} is file. Cann't create same name directory.".format( 40 | get_colorful_str(path, color_code="red", end="") 41 | ) 42 | ) 43 | exit(1) 44 | elif os.path.isdir(path): 45 | pass 46 | else: 47 | if VERBOSE: 48 | my_print("mkdir -p {}".format(path)) 49 | os.system("mkdir -p {}".format(escape(path))) 50 | 51 | 52 | def get_current_path(): 53 | try: 54 | # return os.path.abspath(os.getcwd()) 55 | # Support Symbolic Link 56 | return os.path.abspath(os.environ["PWD"]) 57 | except Exception: 58 | return None 59 | 60 | 61 | def get_colorful_str(s, end="\n", color_code=None): 62 | if color_code and ENABLE_COLOR: 63 | color_code = COLORS[color_code] 64 | s = "\033[{}m{}\033[0m".format(color_code, s) 65 | return "{}{}".format(s, end) 66 | 67 | 68 | def my_print(s, end="\n", color_code=None): 69 | try: 70 | sys.stdout.write(get_colorful_str(s, end, color_code)) 71 | except: 72 | pass 73 | 74 | 75 | def get_size_color_code(size_str): 76 | index = len(size_str[:-1].split(".")[0]) - 1 77 | sign = size_str[-1].strip("1234567890 .") 78 | return FILE_SIZE_COLORS.get(sign)[index] 79 | 80 | 81 | def get_path_size_str(file_path): 82 | return str( 83 | subprocess.check_output(["du", "-sh", file_path]).split()[0].decode("utf-8") 84 | ) 85 | 86 | 87 | def generate_trash_file_name(file_path): 88 | return datetime.datetime.now().strftime(TRASH_DATETIME_FORMAT) + get_path_size_str( 89 | file_path 90 | ) 91 | 92 | 93 | def directory_exists(directory): 94 | return os.path.isdir(directory) or get_all_files(directory, only_check=True) 95 | 96 | 97 | def get_all_files(directory, only_check=False, absolute_files=False): 98 | files = [ 99 | i.replace("//", "/") for i in glob(directory + "/*") + glob(directory + "/.*") 100 | ] 101 | slash_count = directory.count("/") + 1 102 | if only_check and files: 103 | return True 104 | if absolute_files: 105 | return files 106 | return list(map(lambda x: "/".join(x.split("/")[slash_count:]), files)) 107 | 108 | 109 | def search_files(directory, file_regex, absolute_files=True): 110 | if file_regex == "\.": 111 | return [directory] 112 | if not (file_regex and directory_exists(directory)): 113 | return [] 114 | 115 | files = get_all_files(directory, absolute_files=absolute_files) 116 | tmp_files = list(filter(lambda x: x.endswith("/" + file_regex), files)) 117 | if tmp_files: 118 | return tmp_files 119 | if file_regex == "*": 120 | return files 121 | file_compile = re.compile(file_regex) 122 | if absolute_files: 123 | match_fun = lambda x: file_compile.match(x.split("/")[-1]) 124 | else: 125 | match_fun = file_compile.match 126 | return list(filter(match_fun, files)) 127 | 128 | 129 | def execute_delete(path): 130 | if VERBOSE: 131 | my_print("rm -rf {}".format(path)) 132 | os.system("rm -rf {}".format(escape(path))) 133 | 134 | 135 | def execute_dir_delete(path): 136 | if VERBOSE: 137 | my_print("rmdir {}".format(path)) 138 | os.system("rmdir {}".format(escape(path))) 139 | 140 | 141 | def execute_move(source, destination, copy=False): 142 | command = "cp -r" if copy else "mv" 143 | if VERBOSE: 144 | my_print("{} {} {}".format(command, source, destination)) 145 | source = escape(source) 146 | destination = escape(destination) 147 | # Will change current directory to source 148 | os.system("{} {} {}".format(command, source, destination)) 149 | 150 | 151 | def remove_empty_dir(absolute_path): 152 | while not os.path.exists(absolute_path): 153 | absolute_path = absolute_path[: absolute_path.rindex("/")] 154 | if absolute_path == TRASH_PATH: 155 | break 156 | 157 | while os.path.isdir(absolute_path) and not os.listdir(absolute_path): 158 | execute_dir_delete(absolute_path) 159 | absolute_path = absolute_path[: absolute_path.rindex("/")] 160 | if absolute_path == TRASH_PATH: 161 | break 162 | 163 | 164 | def my_input(s): 165 | try: 166 | f = raw_input 167 | except: 168 | f = input 169 | try: 170 | return f(s) 171 | except KeyboardInterrupt: 172 | exit(1) 173 | 174 | 175 | def input_yes(s): 176 | result = my_input(s).lower() in ["yes", "y"] 177 | my_print("") 178 | return result 179 | 180 | 181 | def replace_file(file_path): 182 | if os.path.exists(file_path): 183 | if input_yes( 184 | "\t{} already exists. Replace it? [N/y] ".format( 185 | get_colorful_str(file_path, color_code="red", end="") 186 | ) 187 | ): 188 | absolute_trash_file_dir = TRASH_PATH + file_path 189 | mkdir(absolute_trash_file_dir) 190 | trash_file = os.path.join( 191 | absolute_trash_file_dir, generate_trash_file_name(file_path) 192 | ) 193 | execute_move(file_path, trash_file) 194 | return True 195 | else: 196 | return True 197 | 198 | 199 | def get_absolute_dirs(dirs): 200 | absolute_dirs = [] 201 | 202 | for i in dirs: 203 | if i == "..": 204 | absolute_dirs.pop(-1) 205 | elif absolute_dirs and not (i or absolute_dirs[-1]): 206 | pass 207 | else: 208 | absolute_dirs.append(i) 209 | return absolute_dirs 210 | 211 | 212 | def get_parent_dir_and_file_regex(input_arg): 213 | reverse = True 214 | if input_arg == "/": 215 | return "/", "\.", reverse, "" 216 | parent_dir = get_current_path() 217 | dirs = input_arg.split("/") 218 | raw = "" 219 | if dirs: 220 | raw = os.path.join(TRASH_PATH, "/".join(dirs[:-1])) 221 | if not dirs[0]: 222 | # use absolute path 223 | dirs = get_absolute_dirs(dirs) 224 | else: 225 | dirs = get_absolute_dirs(parent_dir.split("/") + dirs) 226 | parent_dir = "/".join(dirs[:-1]) or "/" 227 | 228 | file_regex = dirs[-1] if dirs else input_arg 229 | return parent_dir, file_regex, reverse, raw 230 | 231 | 232 | def operations(): 233 | for arg in sys.argv[1:]: 234 | if arg != "/": 235 | arg = arg.rstrip("/") 236 | arg = arg[2:] if arg[:2] == "./" else arg 237 | 238 | parent_dir, file_regex, reverse, raw = get_parent_dir_and_file_regex(arg) 239 | if not arg: 240 | continue 241 | yield parent_dir, file_regex, reverse, raw 242 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------