xref: /haiku/src/bin/finddir.c (revision f5821a1aee77d3b9a979b42c68a79e50b5ebaefe)
1 /*
2  * Copyright 2002, Sebastian Nozzi <sebnozzi@gmx.net>.
3  * Copyright 2004, Francois Revol.
4  *
5  * Distributed under the terms of the MIT License.
6  */
7 
8 #include <stdio.h>
9 #include <string.h>
10 
11 #include <FindDirectory.h>
12 #include <fs_info.h>
13 
14 
15 #define NO_ERRORS			0
16 #define ARGUMENT_MISSING	1
17 #define WRONG_DIR_TYPE		2
18 
19 typedef struct {
20 	const char *key;
21 	directory_which value;
22 } directoryType;
23 
24 #define KEYVALUE_PAIR(key) {#key, key}
25 
26 directoryType directoryTypes[] = {
27 	// Generic directories
28 	KEYVALUE_PAIR(B_DESKTOP_DIRECTORY),
29 	KEYVALUE_PAIR(B_TRASH_DIRECTORY),
30 	KEYVALUE_PAIR(B_APPS_DIRECTORY),
31 	KEYVALUE_PAIR(B_PACKAGE_LINKS_DIRECTORY),
32 	KEYVALUE_PAIR(B_PREFERENCES_DIRECTORY),
33 	KEYVALUE_PAIR(B_UTILITIES_DIRECTORY),
34 
35 	// System directories
36 	KEYVALUE_PAIR(B_SYSTEM_DIRECTORY),
37 	KEYVALUE_PAIR(B_SYSTEM_ADDONS_DIRECTORY),
38 	KEYVALUE_PAIR(B_SYSTEM_BOOT_DIRECTORY),
39 	KEYVALUE_PAIR(B_SYSTEM_FONTS_DIRECTORY),
40 	KEYVALUE_PAIR(B_SYSTEM_LIB_DIRECTORY),
41 	KEYVALUE_PAIR(B_SYSTEM_SERVERS_DIRECTORY),
42 	KEYVALUE_PAIR(B_SYSTEM_APPS_DIRECTORY),
43 	KEYVALUE_PAIR(B_SYSTEM_BIN_DIRECTORY),
44 	KEYVALUE_PAIR(B_SYSTEM_DOCUMENTATION_DIRECTORY),
45 	KEYVALUE_PAIR(B_SYSTEM_PREFERENCES_DIRECTORY),
46 	KEYVALUE_PAIR(B_SYSTEM_TRANSLATORS_DIRECTORY),
47 	KEYVALUE_PAIR(B_SYSTEM_MEDIA_NODES_DIRECTORY),
48 	KEYVALUE_PAIR(B_SYSTEM_SOUNDS_DIRECTORY),
49 	KEYVALUE_PAIR(B_SYSTEM_DATA_DIRECTORY),
50 	KEYVALUE_PAIR(B_SYSTEM_DEVELOP_DIRECTORY),
51 	KEYVALUE_PAIR(B_SYSTEM_PACKAGES_DIRECTORY),
52 	KEYVALUE_PAIR(B_SYSTEM_HEADERS_DIRECTORY),
53 
54 	// Common directories
55 	KEYVALUE_PAIR(B_COMMON_DIRECTORY),
56 	KEYVALUE_PAIR(B_COMMON_SYSTEM_DIRECTORY),
57 	KEYVALUE_PAIR(B_COMMON_ADDONS_DIRECTORY),
58 	KEYVALUE_PAIR(B_COMMON_BOOT_DIRECTORY),
59 	KEYVALUE_PAIR(B_COMMON_FONTS_DIRECTORY),
60 	KEYVALUE_PAIR(B_COMMON_LIB_DIRECTORY),
61 	KEYVALUE_PAIR(B_COMMON_SERVERS_DIRECTORY),
62 	KEYVALUE_PAIR(B_COMMON_BIN_DIRECTORY),
63 	KEYVALUE_PAIR(B_COMMON_ETC_DIRECTORY),
64 	KEYVALUE_PAIR(B_COMMON_DOCUMENTATION_DIRECTORY),
65 	KEYVALUE_PAIR(B_COMMON_SETTINGS_DIRECTORY),
66 	KEYVALUE_PAIR(B_COMMON_DEVELOP_DIRECTORY),
67 	KEYVALUE_PAIR(B_COMMON_LOG_DIRECTORY),
68 	KEYVALUE_PAIR(B_COMMON_SPOOL_DIRECTORY),
69 	KEYVALUE_PAIR(B_COMMON_TEMP_DIRECTORY),
70 	KEYVALUE_PAIR(B_COMMON_VAR_DIRECTORY),
71 	KEYVALUE_PAIR(B_COMMON_TRANSLATORS_DIRECTORY),
72 	KEYVALUE_PAIR(B_COMMON_MEDIA_NODES_DIRECTORY),
73 	KEYVALUE_PAIR(B_COMMON_SOUNDS_DIRECTORY),
74 	KEYVALUE_PAIR(B_COMMON_DATA_DIRECTORY),
75 	KEYVALUE_PAIR(B_COMMON_CACHE_DIRECTORY),
76 	KEYVALUE_PAIR(B_COMMON_PACKAGES_DIRECTORY),
77 	KEYVALUE_PAIR(B_COMMON_HEADERS_DIRECTORY),
78 	KEYVALUE_PAIR(B_COMMON_NONPACKAGED_DIRECTORY),
79 	KEYVALUE_PAIR(B_COMMON_NONPACKAGED_ADDONS_DIRECTORY),
80 	KEYVALUE_PAIR(B_COMMON_NONPACKAGED_TRANSLATORS_DIRECTORY),
81 	KEYVALUE_PAIR(B_COMMON_NONPACKAGED_MEDIA_NODES_DIRECTORY),
82 	KEYVALUE_PAIR(B_COMMON_NONPACKAGED_BIN_DIRECTORY),
83 	KEYVALUE_PAIR(B_COMMON_NONPACKAGED_DATA_DIRECTORY),
84 	KEYVALUE_PAIR(B_COMMON_NONPACKAGED_FONTS_DIRECTORY),
85 	KEYVALUE_PAIR(B_COMMON_NONPACKAGED_SOUNDS_DIRECTORY),
86 	KEYVALUE_PAIR(B_COMMON_NONPACKAGED_DOCUMENTATION_DIRECTORY),
87 	KEYVALUE_PAIR(B_COMMON_NONPACKAGED_LIB_DIRECTORY),
88 	KEYVALUE_PAIR(B_COMMON_NONPACKAGED_HEADERS_DIRECTORY),
89 	KEYVALUE_PAIR(B_COMMON_NONPACKAGED_DEVELOP_DIRECTORY),
90 
91 	// User directories
92 	KEYVALUE_PAIR(B_USER_DIRECTORY),
93 	KEYVALUE_PAIR(B_USER_CONFIG_DIRECTORY),
94 	KEYVALUE_PAIR(B_USER_ADDONS_DIRECTORY),
95 	KEYVALUE_PAIR(B_USER_BOOT_DIRECTORY),
96 	KEYVALUE_PAIR(B_USER_FONTS_DIRECTORY),
97 	KEYVALUE_PAIR(B_USER_LIB_DIRECTORY),
98 	KEYVALUE_PAIR(B_USER_SETTINGS_DIRECTORY),
99 	KEYVALUE_PAIR(B_USER_DESKBAR_DIRECTORY),
100 	KEYVALUE_PAIR(B_USER_PRINTERS_DIRECTORY),
101 	KEYVALUE_PAIR(B_USER_TRANSLATORS_DIRECTORY),
102 	KEYVALUE_PAIR(B_USER_MEDIA_NODES_DIRECTORY),
103 	KEYVALUE_PAIR(B_USER_SOUNDS_DIRECTORY),
104 	KEYVALUE_PAIR(B_USER_DATA_DIRECTORY),
105 	KEYVALUE_PAIR(B_USER_CACHE_DIRECTORY),
106 	KEYVALUE_PAIR(B_USER_PACKAGES_DIRECTORY),
107 	KEYVALUE_PAIR(B_USER_DEVELOP_DIRECTORY),
108 	KEYVALUE_PAIR(B_USER_DOCUMENTATION_DIRECTORY),
109 	KEYVALUE_PAIR(B_USER_HEADERS_DIRECTORY),
110 	KEYVALUE_PAIR(B_USER_NONPACKAGED_DIRECTORY),
111 	KEYVALUE_PAIR(B_USER_NONPACKAGED_ADDONS_DIRECTORY),
112 	KEYVALUE_PAIR(B_USER_NONPACKAGED_TRANSLATORS_DIRECTORY),
113 	KEYVALUE_PAIR(B_USER_NONPACKAGED_MEDIA_NODES_DIRECTORY),
114 	KEYVALUE_PAIR(B_USER_NONPACKAGED_BIN_DIRECTORY),
115 	KEYVALUE_PAIR(B_USER_NONPACKAGED_DATA_DIRECTORY),
116 	KEYVALUE_PAIR(B_USER_NONPACKAGED_FONTS_DIRECTORY),
117 	KEYVALUE_PAIR(B_USER_NONPACKAGED_SOUNDS_DIRECTORY),
118 	KEYVALUE_PAIR(B_USER_NONPACKAGED_DOCUMENTATION_DIRECTORY),
119 	KEYVALUE_PAIR(B_USER_NONPACKAGED_LIB_DIRECTORY),
120 	KEYVALUE_PAIR(B_USER_NONPACKAGED_HEADERS_DIRECTORY),
121 	KEYVALUE_PAIR(B_USER_NONPACKAGED_DEVELOP_DIRECTORY),
122 
123 	// Legacy system directories
124 	KEYVALUE_PAIR(B_BEOS_DIRECTORY),
125 	KEYVALUE_PAIR(B_BEOS_SYSTEM_DIRECTORY),
126 	KEYVALUE_PAIR(B_BEOS_ADDONS_DIRECTORY),
127 	KEYVALUE_PAIR(B_BEOS_BOOT_DIRECTORY),
128 	KEYVALUE_PAIR(B_BEOS_FONTS_DIRECTORY),
129 	KEYVALUE_PAIR(B_BEOS_LIB_DIRECTORY),
130 	KEYVALUE_PAIR(B_BEOS_SERVERS_DIRECTORY),
131 	KEYVALUE_PAIR(B_BEOS_APPS_DIRECTORY),
132 	KEYVALUE_PAIR(B_BEOS_BIN_DIRECTORY),
133 	KEYVALUE_PAIR(B_BEOS_ETC_DIRECTORY),
134 	KEYVALUE_PAIR(B_BEOS_DOCUMENTATION_DIRECTORY),
135 	KEYVALUE_PAIR(B_BEOS_PREFERENCES_DIRECTORY),
136 	KEYVALUE_PAIR(B_BEOS_TRANSLATORS_DIRECTORY),
137 	KEYVALUE_PAIR(B_BEOS_MEDIA_NODES_DIRECTORY),
138 	KEYVALUE_PAIR(B_BEOS_SOUNDS_DIRECTORY),
139 	KEYVALUE_PAIR(B_BEOS_DATA_DIRECTORY),
140 
141 	{NULL, B_USER_DESKBAR_DIRECTORY}
142 };
143 
144 
145 static void
146 listDirectoryWhich(void)
147 {
148 	int i;
149 
150 	for (i = 0; directoryTypes[i].key; i++) {
151 		printf("%s\n", directoryTypes[i].key);
152 	}
153 }
154 
155 
156 static bool
157 retrieveDirValue(directoryType *list, const char *key,
158 	directory_which *valueOut)
159 {
160 	unsigned i = 0;
161 
162 	while (list[i].key != NULL) {
163 		if (strcmp(list[i].key, key) == 0) {
164 			*valueOut = list[i].value;
165 			return true;
166 		}
167 
168 		i++;
169 	}
170 
171 	return false;
172 }
173 
174 
175 static void
176 usageMsg()
177 {
178 	printf("usage:  /bin/finddir -l | [ -v volume ] directory_which\n");
179 	printf("\t-l\t    list valid which constants to use\n");
180 	printf("\t-v <file>   use the specified volume for directory\n");
181 	printf("\t\t    constants that are volume-specific.\n");
182 	printf("\t\t    <file> can be any file on that volume.\n");
183 	printf("\t\t    defaults to the boot volume.\n");
184 	printf(" For a description of recognized directory_which constants,\n");
185 	printf(" see the find_directory(...) documentation in the Be Book.\n");
186 }
187 
188 
189 int
190 main(int argc, char *argv[])
191 {
192 	int directoryArgNr;
193 	int status;
194 	dev_t volume;
195 	directory_which dirType;
196 	int returnCode;
197 
198 	status = NO_ERRORS;
199 	directoryArgNr = 1;
200 	returnCode = 0;
201 
202 	dirType = B_BEOS_DIRECTORY; /* so that it compiles */
203 
204 	/* By default use boot volume*/
205 	volume = dev_for_path("/boot");
206 
207 	if (argc <= 1) {
208 		status = ARGUMENT_MISSING;
209 	} else {
210 		if (strcmp(argv[1], "-l") == 0 ) {
211 			listDirectoryWhich();
212 			return 0;
213 		}
214 		if (strcmp(argv[1], "-v") == 0 ) {
215 			if (argc >= 3) {
216 				dev_t temp_volume;
217 				/* get volume from second arg */
218 				temp_volume = dev_for_path(argv[2]);
219 
220 				/* Keep default value in case of error */
221 				if (temp_volume >= 0)
222 					volume = temp_volume;
223 
224 				/* two arguments were used for volume */
225 				directoryArgNr+=2;
226 			} else {
227 				/* set status to argument missing */
228 				status = ARGUMENT_MISSING;
229 			}
230 		}
231 	}
232 
233 	if (status == NO_ERRORS && argc > directoryArgNr) {
234 		/* get directory constant from next argument */
235 
236 		if (!retrieveDirValue(directoryTypes, argv[directoryArgNr], &dirType))
237 			status = WRONG_DIR_TYPE;
238 	} else {
239 		status = ARGUMENT_MISSING;
240 	}
241 
242 	/* Do the actual directoy finding */
243 
244 	if (status == NO_ERRORS) {
245 		/* Question: would B_PATH_NAME_LENGTH alone have been enough? */
246 		char buffer[B_PATH_NAME_LENGTH+B_FILE_NAME_LENGTH];
247 		status_t result = find_directory (dirType, volume, false, buffer,
248 			sizeof(buffer));
249 		if (result == B_OK) {
250 			printf("%s\n", buffer);
251 		} else {
252 			fprintf(stderr, "Failed to get directory: %s\n", strerror(result));
253 			return 1;
254 		}
255 	}
256 
257 	/* Error messages and return code setting */
258 
259 	if (status == WRONG_DIR_TYPE) {
260 		fprintf(stderr, "%s: unrecognized directory_which constant \'%s\'\n", argv[0],
261 			argv[directoryArgNr]);
262 		returnCode = 252;
263 	}
264 
265 	if (status == ARGUMENT_MISSING) {
266 		usageMsg();
267 		returnCode = 255;
268 	}
269 
270 	return returnCode;
271 }
272 
273