aboutsummaryrefslogtreecommitdiff
path: root/toolsrc/src/commands_remove.cpp
blob: a0f846470480912e321705c85bda8f057d6cd9b3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
#include "pch.h"
#include "vcpkg_Commands.h"
#include "vcpkglib.h"
#include "vcpkg_System.h"
#include "vcpkg_Input.h"
#include "vcpkg_Dependencies.h"
#include "vcpkg_Util.h"

namespace vcpkg::Commands::Remove
{
    using Dependencies::package_spec_with_remove_plan;
    using Dependencies::remove_plan_type;
    using Dependencies::request_type;

    static const std::string OPTION_PURGE = "--purge";
    static const std::string OPTION_RECURSE = "--recurse";
    static const std::string OPTION_DRY_RUN = "--dry-run";

    static void delete_directory(const fs::path& directory)
    {
        std::error_code ec;
        fs::remove_all(directory, ec);
        if (!ec)
        {
            System::println(System::color::success, "Cleaned up %s", directory.string());
        }
        if (fs::exists(directory))
        {
            System::println(System::color::warning, "Some files in %s were unable to be removed. Close any editors operating in this directory and retry.", directory.string());
        }
    }

    static void remove_package(const vcpkg_paths& paths, const package_spec& spec, StatusParagraphs* status_db)
    {
        StatusParagraph& pkg = **status_db->find(spec.name(), spec.target_triplet());

        pkg.want = want_t::purge;
        pkg.state = install_state_t::half_installed;
        write_update(paths, pkg);

        std::fstream listfile(paths.listfile_path(pkg.package), std::ios_base::in | std::ios_base::binary);
        if (listfile)
        {
            std::vector<fs::path> dirs_touched;
            std::string suffix;
            while (std::getline(listfile, suffix))
            {
                if (!suffix.empty() && suffix.back() == '\r')
                    suffix.pop_back();

                std::error_code ec;

                auto target = paths.installed / suffix;

                auto status = fs::status(target, ec);
                if (ec)
                {
                    System::println(System::color::error, "failed: %s", ec.message());
                    continue;
                }

                if (fs::is_directory(status))
                {
                    dirs_touched.push_back(target);
                }
                else if (fs::is_regular_file(status))
                {
                    fs::remove(target, ec);
                    if (ec)
                    {
                        System::println(System::color::error, "failed: %s: %s", target.u8string(), ec.message());
                    }
                }
                else if (!fs::status_known(status))
                {
                    System::println(System::color::warning, "Warning: unknown status: %s", target.u8string());
                }
                else
                {
                    System::println(System::color::warning, "Warning: %s: cannot handle file type", target.u8string());
                }
            }

            auto b = dirs_touched.rbegin();
            auto e = dirs_touched.rend();
            for (; b != e; ++b)
            {
                if (fs::directory_iterator(*b) == fs::directory_iterator())
                {
                    std::error_code ec;
                    fs::remove(*b, ec);
                    if (ec)
                    {
                        System::println(System::color::error, "failed: %s", ec.message());
                    }
                }
            }

            listfile.close();
            fs::remove(paths.listfile_path(pkg.package));
        }

        pkg.state = install_state_t::not_installed;
        write_update(paths, pkg);
    }

    static void sort_packages_by_name(std::vector<const package_spec_with_remove_plan*>* packages)
    {
        std::sort(packages->begin(), packages->end(), [](const package_spec_with_remove_plan* left, const package_spec_with_remove_plan* right) -> bool
                  {
                      return left->spec.name() < right->spec.name();
                  });
    }

    static void print_plan(const std::vector<package_spec_with_remove_plan>& plan)
    {
        std::vector<const package_spec_with_remove_plan*> not_installed;
        std::vector<const package_spec_with_remove_plan*> remove;

        for (const package_spec_with_remove_plan& i : plan)
        {
            if (i.plan.plan_type == remove_plan_type::NOT_INSTALLED)
            {
                not_installed.push_back(&i);
                continue;
            }

            if (i.plan.plan_type == remove_plan_type::REMOVE)
            {
                remove.push_back(&i);
                continue;
            }

            Checks::unreachable(VCPKG_LINE_INFO);
        }

        if (!not_installed.empty())
        {
            sort_packages_by_name(&not_installed);
            System::println("The following packages are not installed, so not removed:\n%s",
                            Strings::join("\n    ", not_installed, [](const package_spec_with_remove_plan* p)
                                          {
                                              return "    " + p->spec.toString();
                                          }));
        }

        if (!remove.empty())
        {
            sort_packages_by_name(&remove);
            System::println("The following packages will be removed:\n%s",
                            Strings::join("\n", remove, [](const package_spec_with_remove_plan* p)
                                          {
                                              if (p->plan.request_type == Dependencies::request_type::AUTO_SELECTED)
                                              {
                                                  return "  * " + p->spec.toString();
                                              }

                                              if (p->plan.request_type == Dependencies::request_type::USER_REQUESTED)
                                              {
                                                  return "    " + p->spec.toString();
                                              }

                                              Checks::unreachable(VCPKG_LINE_INFO);
                                          }));
        }
    }

    void perform_and_exit(const vcpkg_cmd_arguments& args, const vcpkg_paths& paths, const triplet& default_target_triplet)
    {
        static const std::string example = Commands::Help::create_example_string("remove zlib zlib:x64-windows curl boost");
        args.check_min_arg_count(1, example);

        auto specs = Util::fmap(args.command_arguments, [&](auto&& arg)
        {
            auto spec = Input::check_and_get_package_spec(arg, default_target_triplet, example);
            Input::check_triplet(spec.target_triplet(), paths);
            return spec;
        });

        const std::unordered_set<std::string> options = args.check_and_get_optional_command_arguments({ OPTION_PURGE, OPTION_RECURSE, OPTION_DRY_RUN });
        const bool alsoRemoveFolderFromPackages = options.find(OPTION_PURGE) != options.end();
        const bool isRecursive = options.find(OPTION_RECURSE) != options.end();
        const bool dryRun = options.find(OPTION_DRY_RUN) != options.end();

        auto status_db = database_load_check(paths);
        const std::vector<package_spec_with_remove_plan> remove_plan = Dependencies::create_remove_plan(specs, status_db);
        Checks::check_exit(VCPKG_LINE_INFO, !remove_plan.empty(), "Remove plan cannot be empty");

        print_plan(remove_plan);
        if (dryRun)
        {
            Checks::exit_success(VCPKG_LINE_INFO);
        }

        const bool has_non_user_requested_packages = std::find_if(remove_plan.cbegin(), remove_plan.cend(), [](const package_spec_with_remove_plan& package)-> bool
                                                                  {
                                                                      return package.plan.request_type != request_type::USER_REQUESTED;
                                                                  }) != remove_plan.cend();

        if (has_non_user_requested_packages && !isRecursive)
        {
            System::println(System::color::warning,
                            "Additional packages (*) need to be removed to complete this operation.\n"
                            "If you are sure you want to remove them, run the command with the --recurse option");
            Checks::exit_fail(VCPKG_LINE_INFO);
        }

        for (const package_spec_with_remove_plan& action : remove_plan)
        {
            const std::string display_name = action.spec.display_name();

            switch (action.plan.plan_type)
            {
                case remove_plan_type::NOT_INSTALLED:
                    System::println(System::color::success, "Package %s is not installed", display_name);
                    break;
                case remove_plan_type::REMOVE:
                    System::println("Removing package %s... ", display_name);
                    remove_package(paths, action.spec, &status_db);
                    System::println(System::color::success, "Removing package %s... done", display_name);
                    break;
                case remove_plan_type::UNKNOWN:
                default:
                    Checks::unreachable(VCPKG_LINE_INFO);
            }

            if (alsoRemoveFolderFromPackages)
            {
                System::println("Purging package %s... ", display_name);
                delete_directory(paths.packages / action.spec.dir());
                System::println(System::color::success, "Purging package %s... done", display_name);
            }
        }

        Checks::exit_success(VCPKG_LINE_INFO);
    }
}