aboutsummaryrefslogtreecommitdiff
path: root/paludis/fs_merger.hh
blob: 9843528c05480d3ccb61c6fd1eea48388cf4313a (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
238
239
240
241
242
243
/* vim: set sw=4 sts=4 et foldmethod=syntax : */

/*
 * Copyright (c) 2007, 2008, 2009, 2010, 2011 Ciaran McCreesh
 *
 * This file is part of the Paludis package manager. Paludis is free software;
 * you can redistribute it and/or modify it under the terms of the GNU General
 * Public License version 2, as published by the Free Software Foundation.
 *
 * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef PALUDIS_GUARD_PALUDIS_FS_MERGER_HH
#define PALUDIS_GUARD_PALUDIS_FS_MERGER_HH 1

#include <paludis/fs_merger-fwd.hh>
#include <paludis/util/exception.hh>
#include <paludis/util/options.hh>
#include <paludis/util/named_value.hh>
#include <paludis/util/timestamp.hh>
#include <paludis/merger_entry_type.hh>
#include <paludis/merger.hh>
#include <paludis/environment-fwd.hh>
#include <paludis/hook-fwd.hh>
#include <iosfwd>
#include <sys/stat.h>
#include <sys/types.h>

/** \file
 * Declarations for the FSMerger class, which can be used by Repository
 * implementations to perform to-filesystem merging.
 *
 * \ingroup g_repository
 *
 * \section Examples
 *
 * - None at this time.
 */

namespace paludis
{
    namespace n
    {
        typedef Name<struct name_environment> environment;
        typedef Name<struct name_fix_mtimes_before> fix_mtimes_before;
        typedef Name<struct name_fs_merger_options> fs_merger_options;
        typedef Name<struct name_get_new_ids_or_minus_one> get_new_ids_or_minus_one;
        typedef Name<struct name_image> image;
        typedef Name<struct name_install_under> install_under;
        typedef Name<struct name_maybe_output_manager> maybe_output_manager;
        typedef Name<struct name_merged_entries> merged_entries;
        typedef Name<struct name_no_chown> no_chown;
        typedef Name<struct name_options> options;
        typedef Name<struct name_permit_destination> permit_destination;
        typedef Name<struct name_root> root;
    }

    /**
     * Parameters for a basic FSMerger.
     *
     * \see Merger
     * \ingroup g_repository
     * \nosubgrouping
     * \since 0.30
     * \since 0.51 called FSMergerParams instead of MergerParams
     */
    struct FSMergerParams
    {
        NamedValue<n::environment, Environment *> environment;

        /**
         * Rewrite any mtimes that are before this time to this time, even if
         * preserving mtimes.
         *
         * \since 0.44
         */
        NamedValue<n::fix_mtimes_before, Timestamp> fix_mtimes_before;

        /**
         * Additional options not in MergerOptions.
         *
         * \since 0.71
         */
        NamedValue<n::fs_merger_options, FSMergerOptions> fs_merger_options;

        NamedValue<n::get_new_ids_or_minus_one, std::function<std::pair<uid_t, gid_t> (const FSPath &)> > get_new_ids_or_minus_one;
        NamedValue<n::image, FSPath> image;
        NamedValue<n::install_under, FSPath> install_under;

        NamedValue<n::maybe_output_manager, std::shared_ptr<OutputManager> > maybe_output_manager;

        /**
         * We record things we merged here.
         *
         * \since 0.41
         */
        NamedValue<n::merged_entries, std::shared_ptr<FSPathSet> > merged_entries;

        NamedValue<n::no_chown, bool> no_chown;
        NamedValue<n::options, MergerOptions> options;

        ///\since 0.66
        NamedValue<n::permit_destination, PermitDestinationFn> permit_destination;

        NamedValue<n::root, FSPath> root;
    };

    /**
     * Thrown if an error occurs during an FSMerger operation.
     *
     * \ingroup g_repository
     * \ingroup g_exceptions
     * \nosubgrouping
     */
    class PALUDIS_VISIBLE FSMergerError :
        public MergerError
    {
        public:
            ///\name Basic operations
            ///\{

            FSMergerError(const std::string & msg) throw ();

            ///\}
    };

    /**
     * Handles merging an image to a live filesystem.
     *
     * \ingroup g_exceptions
     * \ingroup g_repository
     * \nosubgrouping
     * \since 0.51 called FSMerger instead of Merger
     */
    class PALUDIS_VISIBLE FSMerger :
        public Merger
    {
        private:
            void track_renamed_dir_recursive(const FSPath &);
            void relabel_dir_recursive(const FSPath &, const FSPath &);
            void try_to_copy_xattrs(const FSPath &, int, FSMergerStatusFlags &);

            Pimp<FSMerger> _imp;

        protected:
            ///\name Basic operations
            ///\{

            FSMerger(const FSMergerParams &);

            ///\}

            virtual Hook extend_hook(const Hook &);

            ///\name Track and record merges
            ///\{

            void track_install_file(const FSPath &, const FSPath &, const std::string &, const FSMergerStatusFlags &);
            void track_install_dir(const FSPath &, const FSPath &, const FSMergerStatusFlags &);
            void track_install_under_dir(const FSPath &, const FSMergerStatusFlags &);
            void track_install_sym(const FSPath &, const FSPath &, const FSMergerStatusFlags &);

            ///\}

            ///\name Handle filesystem entry things
            ///\{

            virtual void on_file_main(bool is_check, const FSPath & src, const FSPath & dst);
            virtual void on_file_over_nothing(bool is_check, const FSPath &, const FSPath &);
            virtual void on_file_over_file(bool is_check, const FSPath &, const FSPath &);
            virtual void on_file_over_dir(bool is_check, const FSPath &, const FSPath &);
            virtual void on_file_over_sym(bool is_check, const FSPath &, const FSPath &);
            virtual void on_file_over_misc(bool is_check, const FSPath &, const FSPath &);

            virtual FSMergerStatusFlags install_file(const FSPath &, const FSPath &, const std::string &) PALUDIS_ATTRIBUTE((warn_unused_result));
            virtual void unlink_file(FSPath);
            virtual void record_install_file(const FSPath &, const FSPath &, const std::string &, const FSMergerStatusFlags &) = 0;

            virtual void on_dir_main(bool is_check, const FSPath & src, const FSPath & dst);
            virtual void on_dir_over_nothing(bool is_check, const FSPath &, const FSPath &);
            virtual void on_dir_over_file(bool is_check, const FSPath &, const FSPath &);
            virtual void on_dir_over_dir(bool is_check, const FSPath &, const FSPath &);
            virtual void on_dir_over_sym(bool is_check, const FSPath &, const FSPath &);
            virtual void on_dir_over_misc(bool is_check, const FSPath &, const FSPath &);

            virtual FSMergerStatusFlags install_dir(const FSPath &, const FSPath &) PALUDIS_ATTRIBUTE((warn_unused_result));
            virtual void unlink_dir(FSPath);
            virtual void record_install_dir(const FSPath &, const FSPath &, const FSMergerStatusFlags &) = 0;
            virtual void record_install_under_dir(const FSPath &, const FSMergerStatusFlags &) = 0;

            virtual void on_sym_main(bool is_check, const FSPath & src, const FSPath & dst);
            virtual void on_sym_over_nothing(bool is_check, const FSPath &, const FSPath &);
            virtual void on_sym_over_file(bool is_check, const FSPath &, const FSPath &);
            virtual void on_sym_over_dir(bool is_check, const FSPath &, const FSPath &);
            virtual void on_sym_over_sym(bool is_check, const FSPath &, const FSPath &);
            virtual void on_sym_over_misc(bool is_check, const FSPath &, const FSPath &);

            virtual FSMergerStatusFlags install_sym(const FSPath &, const FSPath &) PALUDIS_ATTRIBUTE((warn_unused_result));
            virtual void unlink_sym(FSPath);
            virtual void record_install_sym(const FSPath &, const FSPath &, const FSMergerStatusFlags &) = 0;

            virtual void unlink_misc(FSPath);

            virtual void prepare_install_under();

            virtual FSPath canonicalise_root_path(const FSPath & f);

            virtual void do_dir_recursive(bool is_check, const FSPath &, const FSPath &);

            ///\}

            ///\name Configuration protection
            ///\{

            virtual bool config_protected(const FSPath &, const FSPath &) = 0;
            virtual std::string make_config_protect_name(const FSPath &, const FSPath &) = 0;

            ///\}

        public:
            ///\name Basic operations
            ///\{

            virtual ~FSMerger();

            FSMerger(const FSMerger &) = delete;
            FSMerger & operator= (const FSMerger &) = delete;

            ///\}

            virtual void merge();
    };

}

#endif