|
2926
|
1 /* |
|
|
2 |
|
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
|
20 |
|
|
21 */ |
|
|
22 |
|
|
23 /* |
|
|
24 |
|
|
25 The functions listed below were adapted from a similar functions |
|
|
26 from GNU Bash, the Bourne Again SHell, copyright (C) 1987, 1989, 1991 |
|
|
27 Free Software Foundation, Inc. |
|
|
28 |
|
|
29 octave_env::do_absolute_pathname |
|
|
30 octave_env::do_base_pathname |
|
|
31 octave_env::do_chdir |
|
|
32 octave_env::do_getcwd |
|
|
33 octave_env::do_make_absolute |
|
|
34 octave_env::do_polite_directory_format |
|
|
35 octave_env::pathname_backup |
|
|
36 |
|
|
37 */ |
|
|
38 |
|
|
39 #ifdef HAVE_CONFIG_H |
|
|
40 #include <config.h> |
|
|
41 #endif |
|
|
42 |
|
|
43 #include <cstdlib> |
|
3504
|
44 #include <string> |
|
2926
|
45 |
|
|
46 #ifdef HAVE_UNISTD_H |
|
|
47 #ifdef HAVE_SYS_TYPES_H |
|
|
48 #include <sys/types.h> |
|
|
49 #endif |
|
|
50 #include <unistd.h> |
|
|
51 #endif |
|
|
52 |
|
|
53 #include "lo-error.h" |
|
|
54 #include "lo-sysdep.h" |
|
|
55 #include "lo-utils.h" |
|
|
56 #include "oct-env.h" |
|
2934
|
57 #include "oct-passwd.h" |
|
2947
|
58 #include "oct-syscalls.h" |
|
2926
|
59 |
|
|
60 octave_env::octave_env (void) |
|
|
61 : follow_symbolic_links (true), verbatim_pwd (true), |
|
|
62 current_directory (), program_name (), program_invocation_name (), |
|
|
63 user_name (), host_name () |
|
|
64 { |
|
|
65 // Get a real value for the current directory. |
|
|
66 do_getcwd (); |
|
|
67 |
|
|
68 // Etc. |
|
|
69 do_get_user_name (); |
|
|
70 |
|
|
71 do_get_host_name (); |
|
|
72 } |
|
|
73 |
|
|
74 octave_env *octave_env::instance = 0; |
|
|
75 |
|
|
76 bool |
|
|
77 octave_env::instance_ok (void) |
|
|
78 { |
|
|
79 bool retval = true; |
|
|
80 |
|
|
81 if (! instance) |
|
|
82 instance = new octave_env (); |
|
|
83 |
|
|
84 if (! instance) |
|
|
85 { |
|
|
86 (*current_liboctave_error_handler) |
|
|
87 ("unable to create current working directoy object!"); |
|
|
88 |
|
|
89 retval = false; |
|
|
90 } |
|
|
91 |
|
|
92 return retval; |
|
|
93 } |
|
|
94 |
|
3504
|
95 std::string |
|
|
96 octave_env::polite_directory_format (const std::string& name) |
|
2926
|
97 { |
|
|
98 return (instance_ok ()) |
|
3504
|
99 ? instance->do_polite_directory_format (name) : std::string (); |
|
2926
|
100 } |
|
|
101 |
|
|
102 bool |
|
3504
|
103 octave_env::absolute_pathname (const std::string& s) |
|
2926
|
104 { |
|
|
105 return (instance_ok ()) |
|
|
106 ? instance->do_absolute_pathname (s) : false; |
|
|
107 } |
|
|
108 |
|
3504
|
109 std::string |
|
|
110 octave_env::base_pathname (const std::string& s) |
|
2926
|
111 { |
|
|
112 return (instance_ok ()) |
|
3504
|
113 ? instance->do_base_pathname (s) : std::string (); |
|
2926
|
114 } |
|
|
115 |
|
3504
|
116 std::string |
|
|
117 octave_env::make_absolute (const std::string& s, const std::string& dot_path) |
|
2926
|
118 { |
|
|
119 return (instance_ok ()) |
|
3504
|
120 ? instance->do_make_absolute (s, dot_path) : std::string (); |
|
2926
|
121 } |
|
|
122 |
|
3504
|
123 std::string |
|
2926
|
124 octave_env::getcwd () |
|
|
125 { |
|
|
126 return (instance_ok ()) |
|
3504
|
127 ? instance->do_getcwd () : std::string (); |
|
2926
|
128 } |
|
|
129 |
|
3504
|
130 std::string |
|
2926
|
131 octave_env::get_home_directory () |
|
|
132 { |
|
|
133 return (instance_ok ()) |
|
3504
|
134 ? instance->do_get_home_directory () : std::string (); |
|
2926
|
135 } |
|
|
136 |
|
3504
|
137 std::string |
|
2926
|
138 octave_env::get_program_name (void) |
|
|
139 { |
|
|
140 return (instance_ok ()) |
|
3504
|
141 ? instance->program_name : std::string (); |
|
2926
|
142 } |
|
|
143 |
|
3504
|
144 std::string |
|
2926
|
145 octave_env::get_program_invocation_name (void) |
|
|
146 { |
|
|
147 return (instance_ok ()) |
|
3504
|
148 ? instance->program_invocation_name : std::string (); |
|
2926
|
149 } |
|
|
150 |
|
|
151 void |
|
3504
|
152 octave_env::set_program_name (const std::string& s) |
|
2926
|
153 { |
|
|
154 if (instance_ok ()) |
|
|
155 instance->do_set_program_name (s); |
|
|
156 } |
|
|
157 |
|
3504
|
158 std::string |
|
2926
|
159 octave_env::get_user_name (void) |
|
|
160 { |
|
|
161 return (instance_ok ()) |
|
3504
|
162 ? instance->do_get_user_name () : std::string (); |
|
2926
|
163 } |
|
|
164 |
|
3504
|
165 std::string |
|
2926
|
166 octave_env::get_host_name (void) |
|
|
167 { |
|
|
168 return (instance_ok ()) |
|
3504
|
169 ? instance->do_get_host_name () : std::string (); |
|
2926
|
170 } |
|
|
171 |
|
|
172 // XXX FIXME XXX -- this leaves no way to distinguish between a |
|
|
173 // variable that is not set and one that is set to the empty string. |
|
|
174 // Is this a problem? |
|
|
175 |
|
3504
|
176 std::string |
|
|
177 octave_env::getenv (const std::string& name) |
|
2926
|
178 { |
|
|
179 return (instance_ok ()) |
|
3504
|
180 ? instance->do_getenv (name) : std::string (); |
|
2926
|
181 } |
|
|
182 |
|
|
183 void |
|
3504
|
184 octave_env::putenv (const std::string& name, const std::string& value) |
|
2926
|
185 { |
|
|
186 octave_putenv (name, value); |
|
|
187 } |
|
|
188 |
|
|
189 bool |
|
3504
|
190 octave_env::chdir (const std::string& newdir) |
|
2926
|
191 { |
|
|
192 return (instance_ok ()) |
|
|
193 ? instance->do_chdir (newdir) : false; |
|
|
194 } |
|
|
195 |
|
|
196 void |
|
3504
|
197 octave_env::do_set_program_name (const std::string& s) const |
|
2926
|
198 { |
|
|
199 program_invocation_name = s; |
|
|
200 |
|
|
201 size_t pos = program_invocation_name.rfind ('/'); |
|
|
202 |
|
|
203 program_name = (pos == NPOS) |
|
|
204 ? program_invocation_name : program_invocation_name.substr (pos+1); |
|
|
205 } |
|
|
206 |
|
|
207 // Return a pretty pathname. If the first part of the pathname is the |
|
|
208 // same as $HOME, then replace that with `~'. |
|
|
209 |
|
3504
|
210 std::string |
|
|
211 octave_env::do_polite_directory_format (const std::string& name) const |
|
2926
|
212 { |
|
3504
|
213 std::string retval; |
|
2926
|
214 |
|
3504
|
215 std::string home_dir = do_get_home_directory (); |
|
2926
|
216 |
|
|
217 size_t len = home_dir.length (); |
|
|
218 |
|
3516
|
219 if (len > 1 && home_dir == name.substr (0, len) |
|
2926
|
220 && (name.length () == len || name[len] == '/')) |
|
|
221 { |
|
|
222 retval = "~"; |
|
|
223 retval.append (name.substr (len)); |
|
|
224 } |
|
|
225 else |
|
|
226 retval = name; |
|
|
227 |
|
|
228 return retval; |
|
|
229 } |
|
|
230 |
|
4088
|
231 static inline bool |
|
|
232 is_dir_sep (char c) |
|
|
233 { |
|
4087
|
234 #if defined (__CYGWIN__) |
|
4088
|
235 return (c == '/' || c == '\\'); |
|
4087
|
236 #else |
|
4088
|
237 return (c == '/'); |
|
4087
|
238 #endif |
|
4088
|
239 } |
|
2926
|
240 |
|
|
241 bool |
|
3504
|
242 octave_env::do_absolute_pathname (const std::string& s) const |
|
2926
|
243 { |
|
4087
|
244 size_t len = s.length (); |
|
|
245 |
|
|
246 if (len == 0) |
|
|
247 return false; |
|
2926
|
248 |
|
|
249 if (s[0] == '/') |
|
|
250 return true; |
|
|
251 |
|
4087
|
252 #if defined (__CYGWIN__) |
|
4088
|
253 if ((len == 2 && isalpha (s[0]) && s[1] == ':') |
|
|
254 || (len > 2 && isalpha (s[0]) && s[1] == ':' && is_dir_sep (s[2]))) |
|
4087
|
255 return true; |
|
|
256 #endif |
|
|
257 |
|
2926
|
258 return false; |
|
|
259 } |
|
|
260 |
|
|
261 // Return the `basename' of the pathname in STRING (the stuff after |
|
|
262 // the last '/'). If STRING is not a full pathname, simply return it. |
|
|
263 |
|
3504
|
264 std::string |
|
|
265 octave_env::do_base_pathname (const std::string& s) const |
|
2926
|
266 { |
|
|
267 if (! do_absolute_pathname (s)) |
|
|
268 return s; |
|
|
269 |
|
|
270 size_t pos = s.rfind ('/'); |
|
|
271 |
|
|
272 if (pos == NPOS) |
|
|
273 return s; |
|
|
274 else |
|
|
275 return s.substr (pos+1); |
|
|
276 } |
|
|
277 |
|
|
278 // Turn STRING (a pathname) into an absolute pathname, assuming that |
|
|
279 // DOT_PATH contains the symbolic location of '.'. |
|
|
280 |
|
3504
|
281 std::string |
|
|
282 octave_env::do_make_absolute (const std::string& s, |
|
|
283 const std::string& dot_path) const |
|
2926
|
284 { |
|
|
285 #if defined (__EMX__) |
|
|
286 if (s.length () > 1 && s[1] == ':') |
|
|
287 return s; |
|
|
288 #endif |
|
|
289 |
|
4087
|
290 if (dot_path.empty () || s.empty () || do_absolute_pathname (s)) |
|
2926
|
291 return s; |
|
|
292 |
|
3504
|
293 std::string current_path = dot_path; |
|
2926
|
294 |
|
|
295 if (current_path.empty ()) |
|
|
296 current_path = "./"; |
|
|
297 |
|
|
298 size_t pos = current_path.length () - 1; |
|
|
299 |
|
|
300 if (current_path[pos] != '/') |
|
|
301 current_path.append ("/"); |
|
|
302 |
|
|
303 size_t i = 0; |
|
|
304 size_t slen = s.length (); |
|
|
305 |
|
|
306 while (i < slen) |
|
|
307 { |
|
|
308 if (s[i] == '.') |
|
|
309 { |
|
|
310 if (i + 1 == slen) |
|
|
311 return current_path; |
|
|
312 |
|
|
313 if (s[i+1] == '/') |
|
|
314 { |
|
|
315 i += 2; |
|
|
316 continue; |
|
|
317 } |
|
|
318 |
|
|
319 if (s[i+1] == '.' && (i + 2 == slen || s[i+2] == '/')) |
|
|
320 { |
|
|
321 i += 2; |
|
|
322 |
|
|
323 if (i != slen) |
|
|
324 i++; |
|
|
325 |
|
|
326 pathname_backup (current_path, 1); |
|
|
327 |
|
|
328 continue; |
|
|
329 } |
|
|
330 } |
|
|
331 |
|
|
332 size_t tmp = s.find ('/', i); |
|
|
333 |
|
|
334 if (tmp == NPOS) |
|
|
335 { |
|
|
336 current_path.append (s, i, tmp-i); |
|
|
337 break; |
|
|
338 } |
|
|
339 else |
|
|
340 { |
|
|
341 current_path.append (s, i, tmp-i+1); |
|
|
342 i = tmp + 1; |
|
|
343 } |
|
|
344 } |
|
|
345 |
|
|
346 return current_path; |
|
|
347 } |
|
|
348 |
|
|
349 // Return a consed string which is the current working directory. |
|
|
350 |
|
3504
|
351 std::string |
|
2926
|
352 octave_env::do_getcwd () |
|
|
353 { |
|
|
354 if (! follow_symbolic_links) |
|
|
355 current_directory = ""; |
|
|
356 |
|
|
357 if (verbatim_pwd || current_directory.empty ()) |
|
|
358 current_directory = ::octave_getcwd (); |
|
|
359 |
|
|
360 return current_directory; |
|
|
361 } |
|
|
362 |
|
|
363 // This value is not cached because it can change while Octave is |
|
|
364 // running. |
|
|
365 |
|
3504
|
366 std::string |
|
2926
|
367 octave_env::do_get_home_directory (void) const |
|
|
368 { |
|
3504
|
369 std::string hd = do_getenv ("HOME"); |
|
2926
|
370 |
|
2947
|
371 if (hd.empty ()) |
|
|
372 { |
|
|
373 octave_passwd pw = octave_passwd::getpwuid (octave_syscalls::getuid ()); |
|
|
374 |
|
3504
|
375 hd = pw ? pw.dir () : std::string ("/"); |
|
2947
|
376 } |
|
|
377 |
|
|
378 return hd; |
|
2926
|
379 } |
|
|
380 |
|
3504
|
381 std::string |
|
2926
|
382 octave_env::do_get_user_name (void) const |
|
|
383 { |
|
|
384 // XXX FIXME XXX -- is it possible for this to change while Octave |
|
|
385 // is running? |
|
|
386 |
|
|
387 if (user_name.empty ()) |
|
|
388 { |
|
2947
|
389 octave_passwd pw = octave_passwd::getpwuid (octave_syscalls::getuid ()); |
|
2926
|
390 |
|
3504
|
391 user_name = pw ? pw.name () : std::string ("unknown"); |
|
2926
|
392 } |
|
|
393 |
|
|
394 return user_name; |
|
|
395 } |
|
|
396 |
|
3504
|
397 std::string |
|
2926
|
398 octave_env::do_get_host_name (void) const |
|
|
399 { |
|
|
400 // XXX FIXME XXX -- is it possible for this to change while Octave |
|
|
401 // is running? |
|
|
402 |
|
|
403 if (host_name.empty ()) |
|
|
404 { |
|
|
405 char hostname[256]; |
|
|
406 |
|
3803
|
407 int status = octave_gethostname (hostname, 255); |
|
2926
|
408 |
|
3185
|
409 host_name = (status < 0) ? "unknown" : hostname; |
|
2926
|
410 } |
|
|
411 |
|
|
412 return host_name; |
|
|
413 } |
|
|
414 |
|
3504
|
415 std::string |
|
|
416 octave_env::do_getenv (const std::string& name) const |
|
2926
|
417 { |
|
|
418 char *value = ::getenv (name.c_str ()); |
|
|
419 |
|
|
420 return value ? value : ""; |
|
|
421 } |
|
|
422 |
|
|
423 // Do the work of changing to the directory NEWDIR. Handle symbolic |
|
|
424 // link following, etc. |
|
|
425 |
|
|
426 bool |
|
3504
|
427 octave_env::do_chdir (const std::string& newdir) |
|
2926
|
428 { |
|
|
429 bool retval = false; |
|
|
430 |
|
3504
|
431 std::string tmp; |
|
2926
|
432 |
|
|
433 if (follow_symbolic_links) |
|
|
434 { |
|
|
435 if (current_directory.empty ()) |
|
|
436 do_getcwd (); |
|
|
437 |
|
|
438 if (current_directory.empty ()) |
|
|
439 tmp = newdir; |
|
|
440 else |
|
|
441 tmp = do_make_absolute (newdir, current_directory); |
|
|
442 |
|
|
443 // Get rid of trailing `/'. |
|
|
444 |
|
|
445 size_t len = tmp.length (); |
|
|
446 |
|
|
447 if (len > 1) |
|
|
448 { |
|
4088
|
449 if (is_dir_sep (tmp[--len])) |
|
2926
|
450 tmp.resize (len); |
|
|
451 } |
|
|
452 |
|
|
453 if (! ::octave_chdir (tmp)) |
|
|
454 { |
|
|
455 current_directory = tmp; |
|
|
456 retval = true; |
|
|
457 } |
|
|
458 } |
|
|
459 else |
|
|
460 retval = (! ::octave_chdir (newdir)); |
|
|
461 |
|
|
462 return retval; |
|
|
463 } |
|
|
464 |
|
|
465 // Remove the last N directories from PATH. |
|
|
466 |
|
|
467 void |
|
3504
|
468 octave_env::pathname_backup (std::string& path, int n) const |
|
2926
|
469 { |
|
|
470 if (path.empty ()) |
|
|
471 return; |
|
|
472 |
|
|
473 size_t i = path.length () - 1; |
|
|
474 |
|
|
475 while (n--) |
|
|
476 { |
|
|
477 while (path[i] == '/' && i > 0) |
|
|
478 i--; |
|
|
479 |
|
|
480 while (path[i] != '/' && i > 0) |
|
|
481 i--; |
|
|
482 |
|
|
483 i++; |
|
|
484 } |
|
|
485 |
|
|
486 path.resize (i); |
|
|
487 } |
|
|
488 |
|
|
489 void |
|
|
490 octave_env::error (int err_num) const |
|
|
491 { |
|
|
492 (*current_liboctave_error_handler) ("%s", strerror (err_num)); |
|
|
493 } |
|
|
494 |
|
|
495 void |
|
3504
|
496 octave_env::error (const std::string& s) const |
|
2926
|
497 { |
|
|
498 (*current_liboctave_error_handler) ("%s", s.c_str ()); |
|
|
499 } |
|
|
500 |
|
|
501 /* |
|
|
502 ;;; Local Variables: *** |
|
|
503 ;;; mode: C++ *** |
|
|
504 ;;; End: *** |
|
|
505 */ |
