/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/clean_tree.py

  • Committer: Jelmer Vernooij
  • Date: 2020-02-07 02:14:30 UTC
  • mto: This revision was merged to the branch mainline in revision 7492.
  • Revision ID: jelmer@jelmer.uk-20200207021430-m49iq3x4x8xlib6x
Drop python2 support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2009, 2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
import errno
 
20
import os
 
21
import shutil
 
22
 
 
23
from . import (
 
24
    controldir,
 
25
    errors,
 
26
    ui,
 
27
    )
 
28
from .osutils import isdir
 
29
from .trace import note
 
30
from .workingtree import WorkingTree
 
31
from .i18n import gettext
 
32
 
 
33
 
 
34
def is_detritus(subp):
 
35
    """Return True if the supplied path is detritus, False otherwise"""
 
36
    return subp.endswith('.THIS') or subp.endswith('.BASE') or\
 
37
        subp.endswith('.OTHER') or subp.endswith('~') or subp.endswith('.tmp')
 
38
 
 
39
 
 
40
def iter_deletables(tree, unknown=False, ignored=False, detritus=False):
 
41
    """Iterate through files that may be deleted"""
 
42
    for subp in tree.extras():
 
43
        if detritus and is_detritus(subp):
 
44
            yield tree.abspath(subp), subp
 
45
            continue
 
46
        if tree.is_ignored(subp):
 
47
            if ignored:
 
48
                yield tree.abspath(subp), subp
 
49
        else:
 
50
            if unknown:
 
51
                yield tree.abspath(subp), subp
 
52
 
 
53
 
 
54
def clean_tree(directory, unknown=False, ignored=False, detritus=False,
 
55
               dry_run=False, no_prompt=False):
 
56
    """Remove files in the specified classes from the tree"""
 
57
    tree = WorkingTree.open_containing(directory)[0]
 
58
    with tree.lock_read():
 
59
        deletables = list(iter_deletables(tree, unknown=unknown,
 
60
                                          ignored=ignored, detritus=detritus))
 
61
        deletables = _filter_out_nested_controldirs(deletables)
 
62
        if len(deletables) == 0:
 
63
            note(gettext('Nothing to delete.'))
 
64
            return 0
 
65
        if not no_prompt:
 
66
            for path, subp in deletables:
 
67
                ui.ui_factory.note(subp)
 
68
            prompt = gettext('Are you sure you wish to delete these')
 
69
            if not ui.ui_factory.get_boolean(prompt):
 
70
                ui.ui_factory.note(gettext('Canceled'))
 
71
                return 0
 
72
        delete_items(deletables, dry_run=dry_run)
 
73
 
 
74
 
 
75
def _filter_out_nested_controldirs(deletables):
 
76
    result = []
 
77
    for path, subp in deletables:
 
78
        # bzr won't recurse into unknowns/ignored directories by default
 
79
        # so we don't pay a penalty for checking subdirs of path for nested
 
80
        # control dir.
 
81
        # That said we won't detect the branch in the subdir of non-branch
 
82
        # directory and therefore delete it. (worth to FIXME?)
 
83
        if isdir(path):
 
84
            try:
 
85
                controldir.ControlDir.open(path)
 
86
            except errors.NotBranchError:
 
87
                result.append((path, subp))
 
88
            else:
 
89
                # TODO may be we need to notify user about skipped directories?
 
90
                pass
 
91
        else:
 
92
            result.append((path, subp))
 
93
    return result
 
94
 
 
95
 
 
96
def delete_items(deletables, dry_run=False):
 
97
    """Delete files in the deletables iterable"""
 
98
    def onerror(function, path, excinfo):
 
99
        """Show warning for errors seen by rmtree.
 
100
        """
 
101
        # Handle only permission error while removing files.
 
102
        # Other errors are re-raised.
 
103
        if function is not os.remove or excinfo[1].errno != errno.EACCES:
 
104
            raise
 
105
        ui.ui_factory.show_warning(gettext('unable to remove %s') % path)
 
106
    has_deleted = False
 
107
    for path, subp in deletables:
 
108
        if not has_deleted:
 
109
            note(gettext("deleting paths:"))
 
110
            has_deleted = True
 
111
        if not dry_run:
 
112
            if isdir(path):
 
113
                shutil.rmtree(path, onerror=onerror)
 
114
            else:
 
115
                try:
 
116
                    os.unlink(path)
 
117
                    note('  ' + subp)
 
118
                except OSError as e:
 
119
                    # We handle only permission error here
 
120
                    if e.errno != errno.EACCES:
 
121
                        raise e
 
122
                    ui.ui_factory.show_warning(gettext(
 
123
                        'unable to remove "{0}": {1}.').format(
 
124
                        path, e.strerror))
 
125
        else:
 
126
            note('  ' + subp)
 
127
    if not has_deleted:
 
128
        note(gettext("No files deleted."))