aboutsummaryrefslogtreecommitdiffstats
path: root/src/db/update/Walk.hxx
blob: 33387ab55b76a8776ab3187d48f1b9302a690fe2 (plain) (blame)
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
/*
 * Copyright (C) 2003-2014 The Music Player Daemon Project
 * http://www.musicpd.org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef MPD_UPDATE_WALK_HXX
#define MPD_UPDATE_WALK_HXX

#include "check.h"
#include "Editor.hxx"

#include <sys/stat.h>

struct stat;
struct FileInfo;
struct Directory;
struct archive_plugin;
class LocalStorage;
class ExcludeList;

class UpdateWalk final {
#ifdef ENABLE_ARCHIVE
	friend class UpdateArchiveVisitor;
#endif

#ifndef WIN32
	static constexpr bool DEFAULT_FOLLOW_INSIDE_SYMLINKS = true;
	static constexpr bool DEFAULT_FOLLOW_OUTSIDE_SYMLINKS = true;

	bool follow_inside_symlinks;
	bool follow_outside_symlinks;
#endif

	bool walk_discard;
	bool modified;

	LocalStorage &storage;

	DatabaseEditor editor;

public:
	UpdateWalk(EventLoop &_loop, DatabaseListener &_listener,
		   LocalStorage &_storage);

	/**
	 * Returns true if the database was modified.
	 */
	bool Walk(Directory &root, const char *path, bool discard);

private:
	gcc_pure
	bool SkipSymlink(const Directory *directory,
			 const char *utf8_name) const;

	void RemoveExcludedFromDirectory(Directory &directory,
					 const ExcludeList &exclude_list);

	void PurgeDeletedFromDirectory(Directory &directory);

	void UpdateSongFile2(Directory &directory,
			     const char *name, const char *suffix,
			     const FileInfo &info);

	bool UpdateSongFile(Directory &directory,
			    const char *name, const char *suffix,
			    const FileInfo &info);

	bool UpdateContainerFile(Directory &directory,
				 const char *name, const char *suffix,
				 const FileInfo &info);


#ifdef ENABLE_ARCHIVE
	void UpdateArchiveTree(Directory &parent, const char *name);

	bool UpdateArchiveFile(Directory &directory,
			       const char *name, const char *suffix,
			       const FileInfo &info);

	void UpdateArchiveFile(Directory &directory, const char *name,
			       const FileInfo &info,
			       const archive_plugin &plugin);


#else
	bool UpdateArchiveFile(gcc_unused Directory &directory,
			       gcc_unused const char *name,
			       gcc_unused const char *suffix,
			       gcc_unused const FileInfo &info) {
		return false;
	}
#endif

	bool UpdatePlaylistFile(Directory &directory,
				const char *name, const char *suffix,
				const FileInfo &info);

	bool UpdateRegularFile(Directory &directory,
			       const char *name, const FileInfo &info);

	void UpdateDirectoryChild(Directory &directory,
				  const char *name, const FileInfo &info);

	bool UpdateDirectory(Directory &directory, const FileInfo &info);

	/**
	 * Create the specified directory object if it does not exist
	 * already or if the #stat object indicates that it has been
	 * modified since the last update.  Returns nullptr when it
	 * exists already and is unmodified.
	 *
	 * The caller must lock the database.
	 */
	Directory *MakeDirectoryIfModified(Directory &parent, const char *name,
					   const FileInfo &info);

	Directory *DirectoryMakeChildChecked(Directory &parent,
					     const char *uri_utf8,
					     const char *name_utf8);

	Directory *DirectoryMakeUriParentChecked(Directory &root,
						 const char *uri);

	void UpdateUri(Directory &root, const char *uri);
};

#endif