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
|
{* UltraStar Deluxe - Karaoke Game
*
* UltraStar Deluxe is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*
* $URL$
* $Id$
*}
unit UPathUtils;
interface
{$IFDEF FPC}
{$MODE Delphi}
{$ENDIF}
{$I switches.inc}
uses
SysUtils,
Classes,
UPath;
var
// Absolute Paths
GamePath: IPath;
SoundPath: IPath;
SongPaths: IInterfaceList;
LogPath: IPath;
ThemePath: IPath;
SkinsPath: IPath;
ScreenshotsPath: IPath;
CoverPaths: IInterfaceList;
LanguagesPath: IPath;
PluginPath: IPath;
VisualsPath: IPath;
FontPath: IPath;
ResourcesPath: IPath;
PlaylistPath: IPath;
WebsitePath: IPath;
WebScoresPath: IPath;
SoundFontsPath: IPath;
AvatarsPath: IPath;
function FindPath(out PathResult: IPath; const RequestedPath: IPath; NeedsWritePermission: boolean): boolean;
procedure InitializePaths;
procedure AddSongPath(const Path: IPath);
implementation
uses
StrUtils,
UPlatform,
UCommandLine,
ULog;
procedure AddSpecialPath(var PathList: IInterfaceList; const Path: IPath);
var
Index: integer;
PathAbs, PathTmp: IPath;
OldPath, OldPathAbs, OldPathTmp: IPath;
begin
if (PathList = nil) then
PathList := TInterfaceList.Create;
if Path.Equals(PATH_NONE) or not Path.CreateDirectory(true) then
Exit;
PathTmp := Path.GetAbsolutePath();
PathAbs := PathTmp.AppendPathDelim();
// check if path or a part of the path was already added
for Index := 0 to PathList.Count-1 do
begin
OldPath := PathList[Index] as IPath;
OldPathTmp := OldPath.GetAbsolutePath();
OldPathAbs := OldPathTmp.AppendPathDelim();
// check if the new directory is a sub-directory of a previously added one.
// This is also true, if both paths point to the same directories.
if (OldPathAbs.IsChildOf(PathAbs, false) or OldPathAbs.Equals(PathAbs)) then
begin
// ignore the new path
Exit;
end;
// check if a previously added directory is a sub-directory of the new one.
if (PathAbs.IsChildOf(OldPathAbs, false)) then
begin
// replace the old with the new one.
PathList[Index] := PathAbs;
Exit;
end;
end;
PathList.Add(PathAbs);
end;
procedure AddSongPath(const Path: IPath);
begin
AddSpecialPath(SongPaths, Path);
end;
procedure AddCoverPath(const Path: IPath);
begin
AddSpecialPath(CoverPaths, Path);
end;
(**
* Initialize a path variable
* After setting paths, make sure that paths exist
*)
function FindPath(
out PathResult: IPath;
const RequestedPath: IPath;
NeedsWritePermission: boolean): boolean;
begin
Result := false;
if (RequestedPath.Equals(PATH_NONE)) then
Exit;
// Make sure the directory exists
if (not RequestedPath.CreateDirectory(true)) then
begin
PathResult := PATH_NONE;
Exit;
end;
PathResult := RequestedPath.AppendPathDelim();
if (NeedsWritePermission) and RequestedPath.IsReadOnly() then
Exit;
Result := true;
end;
(**
* Function sets all absolute paths e.g. song path and makes sure the directorys exist
*)
procedure InitializePaths;
var
SharedPath, UserPath: IPath;
begin
// Log directory (must be writable)
if (not FindPath(LogPath, Platform.GetLogPath, true)) then
begin
Log.FileOutputEnabled := false;
Log.LogWarn('Log directory "'+ Platform.GetLogPath.ToNative +'" not available', 'InitializePaths');
end;
SharedPath := Platform.GetGameSharedPath;
UserPath := Platform.GetGameUserPath;
FindPath(SoundPath, SharedPath.Append('sounds'), false);
FindPath(ThemePath, SharedPath.Append('themes'), false);
FindPath(SkinsPath, SharedPath.Append('themes'), false);
FindPath(LanguagesPath, SharedPath.Append('languages'), false);
FindPath(PluginPath, SharedPath.Append('plugins'), false);
FindPath(VisualsPath, SharedPath.Append('visuals'), false);
FindPath(FontPath, SharedPath.Append('fonts'), false);
FindPath(ResourcesPath, SharedPath.Append('resources'), false);
{ add later as required
FindPath(WebsitePath, SharedPath.Append('webs'), false);
FindPath(SoundFontsPath, SharedPath.Append('soundfonts'), false);
FindPath(AvatarsPath, SharedPath.Append('avatars'), false);
}
// Playlists are not shared as we need one directory to write too
FindPath(PlaylistPath, UserPath.Append('playlists'), true);
// Screenshot directory (must be writable)
if (not FindPath(ScreenshotsPath, UserPath.Append('screenshots'), true)) then
begin
Log.LogWarn('Screenshot directory "'+ UserPath.ToNative +'" not available', 'InitializePaths');
end;
// Add song paths
AddSongPath(Params.SongPath);
{$IF Defined(DARWIN)}
AddSongPath(Platform.GetMusicPath);
AddSongPath(UserPath.Append('songs'));
{$ELSE}
AddSongPath(SharedPath.Append('songs'));
AddSongPath(UserPath.Append('songs'));
{$IFEND}
// Add category cover paths
AddCoverPath(SharedPath.Append('covers'));
AddCoverPath(UserPath.Append('covers'));
end;
end.
|
