Support of use ~ as home directory in hotlist.
[midnight-commander.git] / lib / vfs / path.c
blob9d3be50a8d13ecc4eaa9f95ac2f2edffd0b578ad
1 /*
2 Virtual File System path handlers
4 Copyright (C) 2011
5 The Free Software Foundation, Inc.
7 Written by:
8 Slava Zanko <slavazanko@gmail.com>, 2011
10 This file is part of the Midnight Commander.
12 The Midnight Commander is free software: you can redistribute it
13 and/or modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation, either version 3 of the License,
15 or (at your option) any later version.
17 The Midnight Commander is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program. If not, see <http://www.gnu.org/licenses/>.
26 /**
27 * \file
28 * \brief Source: Virtual File System: path handlers
29 * \author Slava Zanko
30 * \date 2011
34 #include <config.h>
36 #include "lib/global.h"
37 #include "lib/strutil.h"
38 #include "lib/util.h" /* mc_build_filename() */
39 #include "lib/serialize.h"
41 #include "vfs.h"
42 #include "utilvfs.h"
43 #include "xdirentry.h"
44 #include "path.h"
46 extern GPtrArray *vfs__classes_list;
48 /*** global variables ****************************************************************************/
50 /*** file scope macro definitions ****************************************************************/
52 /*** file scope type declarations ****************************************************************/
54 /*** file scope variables ************************************************************************/
56 /*** file scope functions ************************************************************************/
57 /* --------------------------------------------------------------------------------------------- */
59 static gboolean
60 path_magic (const char *path)
62 struct stat buf;
64 return (stat (path, &buf) != 0);
67 /* --------------------------------------------------------------------------------------------- */
69 /**
70 * Splits path extracting vfs part.
72 * Splits path
73 * \verbatim /p1#op/inpath \endverbatim
74 * into
75 * \verbatim inpath,op; \endverbatim
76 * returns which vfs it is.
77 * What is left in path is p1. You still want to g_free(path), you DON'T
78 * want to free neither *inpath nor *op
81 static struct vfs_class *
82 _vfs_split_with_semi_skip_count (char *path, const char **inpath, const char **op,
83 size_t skip_count)
85 char *semi;
86 char *slash;
87 struct vfs_class *ret;
89 if (path == NULL)
90 vfs_die ("Cannot split NULL");
92 semi = strrstr_skip_count (path, "#", skip_count);
94 if ((semi == NULL) || (!path_magic (path)))
95 return NULL;
97 slash = strchr (semi, PATH_SEP);
98 *semi = '\0';
100 if (op != NULL)
101 *op = NULL;
103 if (inpath != NULL)
104 *inpath = NULL;
106 if (slash != NULL)
107 *slash = '\0';
109 ret = vfs_prefix_to_class (semi + 1);
110 if (ret != NULL)
112 if (op != NULL)
113 *op = semi + 1;
114 if (inpath != NULL)
115 *inpath = slash != NULL ? slash + 1 : NULL;
116 return ret;
119 if (slash != NULL)
120 *slash = PATH_SEP;
122 *semi = '#';
123 ret = _vfs_split_with_semi_skip_count (path, inpath, op, skip_count + 1);
124 return ret;
127 /* --------------------------------------------------------------------------------------------- */
129 * remove //, /./ and /../
131 * @return newly allocated string
134 static char *
135 vfs_canon (const char *path)
137 if (path == NULL)
138 vfs_die ("Cannot canonicalize NULL");
140 /* Relative to current directory */
141 if (*path != PATH_SEP)
143 char *result, *local;
145 local = tilde_expand (path);
146 if (*local != PATH_SEP)
148 char *curr_dir;
150 g_free (local);
151 curr_dir = vfs_get_current_dir ();
152 local = mc_build_filename (curr_dir, path, NULL);
153 g_free (curr_dir);
156 result = vfs_canon (local);
157 g_free (local);
158 return result;
162 * So we have path of following form:
163 * /p1/p2#op/.././././p3#op/p4. Good luck.
166 char *result;
168 result = g_strdup (path);
169 canonicalize_pathname (result);
170 return result;
174 /* --------------------------------------------------------------------------------------------- */
175 /** get encoding after last #enc: or NULL, if part does not contain #enc:
177 * @param path string
179 * @return newly allocated string.
182 static char *
183 vfs_get_encoding (const char *path)
185 char result[16];
186 char *work;
187 char *semi;
188 char *slash;
189 work = g_strdup (path);
191 /* try found #enc: */
192 semi = g_strrstr (work, VFS_ENCODING_PREFIX);
194 if (semi != NULL && (semi == work || *(semi - 1) == PATH_SEP))
196 semi += strlen (VFS_ENCODING_PREFIX); /* skip "#enc:" */
197 slash = strchr (semi, PATH_SEP);
198 if (slash != NULL)
199 slash[0] = '\0';
201 g_strlcpy (result, semi, sizeof (result));
202 g_free (work);
203 return g_strdup (result);
205 else
207 g_free (work);
208 return NULL;
212 /* --------------------------------------------------------------------------------------------- */
213 /** Extract the hostname and username from the path
215 * Format of the path is [user@]hostname:port/remote-dir, e.g.:
217 * ftp://sunsite.unc.edu/pub/linux
218 * ftp://miguel@sphinx.nuclecu.unam.mx/c/nc
219 * ftp://tsx-11.mit.edu:8192/
220 * ftp://joe@foo.edu:11321/private
221 * ftp://joe:password@foo.se
223 * @param path_element is an input string to be parsed
224 * @param path is an input string to be parsed
226 * @return g_malloc()ed url info.
227 * If the user is empty, e.g. ftp://@roxanne/private, and URL_USE_ANONYMOUS
228 * is not set, then the current login name is supplied.
229 * Return value is a g_malloc()ed structure with the pathname relative to the
230 * host.
233 static void
234 vfs_path_url_split (vfs_path_element_t * path_element, const char *path)
236 char *pcopy;
237 const char *pend;
238 char *dir, *colon, *inner_colon, *at, *rest;
240 path_element->port = 0;
242 pcopy = g_strdup (path);
243 pend = pcopy + strlen (pcopy);
244 dir = pcopy;
246 /* search for any possible user */
247 at = strrchr (pcopy, '@');
249 /* We have a username */
250 if (at == NULL)
251 rest = pcopy;
252 else
254 *at = '\0';
255 inner_colon = strchr (pcopy, ':');
256 if (inner_colon != NULL)
258 *inner_colon = '\0';
259 inner_colon++;
260 path_element->password = g_strdup (inner_colon);
263 if (*pcopy != '\0')
264 path_element->user = g_strdup (pcopy);
266 if (pend == at + 1)
267 rest = at;
268 else
269 rest = at + 1;
272 /* Check if the host comes with a port spec, if so, chop it */
273 if (*rest != '[')
274 colon = strchr (rest, ':');
275 else
277 colon = strchr (++rest, ']');
278 if (colon != NULL)
280 colon[0] = '\0';
281 colon[1] = '\0';
282 colon++;
283 path_element->ipv6 = TRUE;
287 if (colon != NULL)
289 *colon = '\0';
290 if (sscanf (colon + 1, "%d", &path_element->port) == 1)
292 if (path_element->port <= 0 || path_element->port >= 65536)
293 path_element->port = 0;
295 else
296 while (*(++colon) != '\0')
298 switch (*colon)
300 case 'C':
301 path_element->port = 1;
302 break;
303 case 'r':
304 path_element->port = 2;
305 break;
309 path_element->host = g_strdup (rest);
310 g_free (pcopy);
313 /* --------------------------------------------------------------------------------------------- */
315 * get VFS class for the given name
317 * @param class_name name of class
319 * @return pointer to class structure or NULL if class not found
322 static struct vfs_class *
323 vfs_get_class_by_name (const char *class_name)
325 guint i;
327 if (class_name == NULL)
328 return NULL;
330 for (i = 0; i < vfs__classes_list->len; i++)
332 struct vfs_class *vfs = (struct vfs_class *) g_ptr_array_index (vfs__classes_list, i);
333 if ((vfs->name != NULL) && (strcmp (vfs->name, class_name) == 0))
334 return vfs;
337 return NULL;
340 /* --------------------------------------------------------------------------------------------- */
342 * Check if path string contain URL-like elements
344 * @param path_str path
346 * @return TRUE if path is deprecated or FALSE otherwise
349 static gboolean
350 vfs_path_is_str_path_deprecated (const char *path_str)
352 return strstr (path_str, VFS_PATH_URL_DELIMITER) == NULL;
355 /* --------------------------------------------------------------------------------------------- */
356 /** Split path string to path elements by deprecated algorithm.
358 * @param path_str VFS-path
360 * @return pointer to newly created vfs_path_t object with filled path elements array.
363 static vfs_path_t *
364 vfs_path_from_str_deprecated_parser (char *path, vfs_path_flag_t flags)
366 vfs_path_t *vpath;
367 vfs_path_element_t *element;
368 struct vfs_class *class;
369 const char *local, *op;
371 (void) flags;
372 vpath = vfs_path_new ();
374 while ((class = _vfs_split_with_semi_skip_count (path, &local, &op, 0)) != NULL)
376 char *url_params;
377 element = g_new0 (vfs_path_element_t, 1);
378 element->class = class;
379 if (local == NULL)
380 local = "";
381 element->path = vfs_translate_path_n (local);
383 element->encoding = vfs_get_encoding (local);
384 element->dir.converter =
385 (element->encoding != NULL) ? str_crt_conv_from (element->encoding) : INVALID_CONV;
387 url_params = strchr (op, ':'); /* skip VFS prefix */
388 if (url_params != NULL)
390 *url_params = '\0';
391 url_params++;
392 vfs_path_url_split (element, url_params);
395 if (*op != '\0')
396 element->vfs_prefix = g_strdup (op);
398 g_array_prepend_val (vpath->path, element);
400 if (path[0] != '\0')
402 element = g_new0 (vfs_path_element_t, 1);
403 element->class = g_ptr_array_index (vfs__classes_list, 0);
404 element->path = vfs_translate_path_n (path);
406 element->encoding = vfs_get_encoding (path);
407 element->dir.converter =
408 (element->encoding != NULL) ? str_crt_conv_from (element->encoding) : INVALID_CONV;
409 g_array_prepend_val (vpath->path, element);
412 return vpath;
415 /* --------------------------------------------------------------------------------------------- */
416 /** Split path string to path elements by URL algorithm.
418 * @param path_str VFS-path
420 * @return pointer to newly created vfs_path_t object with filled path elements array.
423 static vfs_path_t *
424 vfs_path_from_str_uri_parser (char *path, vfs_path_flag_t flags)
426 vfs_path_t *vpath;
427 vfs_path_element_t *element;
429 char *url_delimiter;
431 vpath = vfs_path_new ();
432 vpath->relative = (flags & VPF_NO_CANON) != 0;
434 while ((url_delimiter = g_strrstr (path, VFS_PATH_URL_DELIMITER)) != NULL)
436 char *vfs_prefix_start;
437 char *real_vfs_prefix_start = url_delimiter;
438 char *slash_pointer;
439 struct vfs_s_subclass *sub = NULL;
441 while (real_vfs_prefix_start > path && *(real_vfs_prefix_start) != PATH_SEP)
442 real_vfs_prefix_start--;
443 vfs_prefix_start = real_vfs_prefix_start;
445 if (*(vfs_prefix_start) == PATH_SEP)
446 vfs_prefix_start += 1;
448 *url_delimiter = '\0';
450 element = g_new0 (vfs_path_element_t, 1);
451 element->class = vfs_prefix_to_class (vfs_prefix_start);
452 element->vfs_prefix = g_strdup (vfs_prefix_start);
454 url_delimiter += strlen (VFS_PATH_URL_DELIMITER);
455 sub = VFSDATA (element);
456 if (sub != NULL && (sub->flags & VFS_S_REMOTE) != 0)
458 slash_pointer = strchr (url_delimiter, PATH_SEP);
459 if (slash_pointer == NULL)
461 element->path = g_strdup ("");
463 else
465 element->path = vfs_translate_path_n (slash_pointer + 1);
466 element->encoding = vfs_get_encoding (slash_pointer);
468 *slash_pointer = '\0';
470 vfs_path_url_split (element, url_delimiter);
472 else
474 element->path = vfs_translate_path_n (url_delimiter);
475 element->encoding = vfs_get_encoding (url_delimiter);
477 element->dir.converter =
478 (element->encoding != NULL) ? str_crt_conv_from (element->encoding) : INVALID_CONV;
479 g_array_prepend_val (vpath->path, element);
481 if ((real_vfs_prefix_start > path && *(real_vfs_prefix_start) == PATH_SEP) ||
482 (real_vfs_prefix_start == path && *(real_vfs_prefix_start) != PATH_SEP))
483 *real_vfs_prefix_start = '\0';
484 else
485 *(real_vfs_prefix_start + 1) = '\0';
488 if (path[0] != '\0')
490 element = g_new0 (vfs_path_element_t, 1);
491 element->class = g_ptr_array_index (vfs__classes_list, 0);
492 element->path = vfs_translate_path_n (path);
493 element->encoding = vfs_get_encoding (path);
494 element->dir.converter =
495 (element->encoding != NULL) ? str_crt_conv_from (element->encoding) : INVALID_CONV;
496 g_array_prepend_val (vpath->path, element);
499 return vpath;
502 /* --------------------------------------------------------------------------------------------- */
504 * Add element's class info to result string (such as VFS name, host, encoding etc)
505 * This function used as helper only in vfs_path_tokens_get() function
507 * @param element current path element
508 * @param ret_tokens total tikens for return
509 * @param element_tokens accumulated element-only tokens
512 static void
513 vfs_path_tokens_add_class_info (const vfs_path_element_t * element, GString * ret_tokens,
514 GString * element_tokens)
516 if (((element->class->flags & VFSF_LOCAL) == 0 || ret_tokens->len > 0)
517 && element_tokens->len > 0)
519 char *url_str;
521 if (ret_tokens->len > 0 && ret_tokens->str[ret_tokens->len - 1] != PATH_SEP)
522 g_string_append_c (ret_tokens, PATH_SEP);
524 g_string_append (ret_tokens, element->vfs_prefix);
525 g_string_append (ret_tokens, VFS_PATH_URL_DELIMITER);
527 url_str = vfs_path_build_url_params_str (element, TRUE);
528 if (*url_str != '\0')
530 g_string_append (ret_tokens, url_str);
531 g_string_append_c (ret_tokens, PATH_SEP);
534 g_free (url_str);
536 if (element->encoding != NULL)
538 if (ret_tokens->len > 0 && ret_tokens->str[ret_tokens->len - 1] != PATH_SEP)
539 g_string_append (ret_tokens, PATH_SEP_STR);
540 g_string_append (ret_tokens, VFS_ENCODING_PREFIX);
541 g_string_append (ret_tokens, element->encoding);
542 g_string_append (ret_tokens, PATH_SEP_STR);
545 g_string_append (ret_tokens, element_tokens->str);
548 /* --------------------------------------------------------------------------------------------- */
550 * Strip path to home dir.
551 * @param dir pointer to string contains full path
554 static char *
555 vfs_path_strip_home (const char *dir)
557 const char *home_dir = mc_config_get_home_dir ();
559 if (home_dir != NULL)
561 size_t len;
563 len = strlen (home_dir);
565 if (strncmp (dir, home_dir, len) == 0 && (dir[len] == PATH_SEP || dir[len] == '\0'))
566 return g_strdup_printf ("~%s", dir + len);
569 return g_strdup (dir);
572 /* --------------------------------------------------------------------------------------------- */
574 /* --------------------------------------------------------------------------------------------- */
575 /*** public functions ****************************************************************************/
576 /* --------------------------------------------------------------------------------------------- */
578 * Convert first elements_count elements from vfs_path_t to string representation with flags.
580 * @param vpath pointer to vfs_path_t object
581 * @param elements_count count of first elements for convert
582 * @param flags flags for converter
584 * @return pointer to newly created string.
587 #define vfs_append_from_path(appendfrom, is_relative) \
589 if ((flags & VPF_STRIP_HOME) && element_index == 0 && (element->class->flags & VFSF_LOCAL) != 0) \
591 char *stripped_home_str; \
592 stripped_home_str = vfs_path_strip_home (appendfrom); \
593 g_string_append (buffer, stripped_home_str); \
594 g_free (stripped_home_str); \
596 else \
598 if ((!is_relative) && (*appendfrom != PATH_SEP) && (*appendfrom != '\0') \
599 && (buffer->len == 0 || buffer->str[buffer->len - 1] != PATH_SEP)) \
600 g_string_append_c (buffer, PATH_SEP); \
601 g_string_append (buffer, appendfrom); \
605 char *
606 vfs_path_to_str_flags (const vfs_path_t * vpath, int elements_count, vfs_path_flag_t flags)
608 int element_index;
609 GString *buffer;
610 GString *recode_buffer;
612 if (vpath == NULL)
613 return NULL;
615 if (elements_count == 0 || elements_count > vfs_path_elements_count (vpath))
616 elements_count = vfs_path_elements_count (vpath);
618 if (elements_count < 0)
619 elements_count = vfs_path_elements_count (vpath) + elements_count;
621 buffer = g_string_new ("");
622 recode_buffer = g_string_new ("");
624 for (element_index = 0; element_index < elements_count; element_index++)
626 const vfs_path_element_t *element;
627 gboolean is_relative = vpath->relative && (element_index == 0);
629 element = vfs_path_get_by_index (vpath, element_index);
630 if (element->vfs_prefix != NULL)
632 char *url_str;
633 if ((!is_relative) && (buffer->len == 0 || buffer->str[buffer->len - 1] != PATH_SEP))
634 g_string_append_c (buffer, PATH_SEP);
636 g_string_append (buffer, element->vfs_prefix);
637 g_string_append (buffer, VFS_PATH_URL_DELIMITER);
639 url_str = vfs_path_build_url_params_str (element, !(flags & VPF_STRIP_PASSWORD));
641 if (*url_str != '\0')
642 g_string_append (buffer, url_str);
644 g_free (url_str);
647 if ((flags & VPF_RECODE) == 0 && vfs_path_element_need_cleanup_converter (element))
649 if ((flags & VPF_HIDE_CHARSET) == 0)
651 if ((!is_relative)
652 && (buffer->len == 0 || buffer->str[buffer->len - 1] != PATH_SEP))
653 g_string_append (buffer, PATH_SEP_STR);
654 g_string_append (buffer, VFS_ENCODING_PREFIX);
655 g_string_append (buffer, element->encoding);
657 str_vfs_convert_from (element->dir.converter, element->path, recode_buffer);
658 vfs_append_from_path (recode_buffer->str, is_relative);
659 g_string_set_size (recode_buffer, 0);
661 else
663 vfs_append_from_path (element->path, is_relative);
666 g_string_free (recode_buffer, TRUE);
667 return g_string_free (buffer, FALSE);
670 #undef vfs_append_from_path
672 /* --------------------------------------------------------------------------------------------- */
674 * Convert first elements_count elements from vfs_path_t to string representation.
676 * @param vpath pointer to vfs_path_t object
677 * @param elements_count count of first elements for convert
679 * @return pointer to newly created string.
682 char *
683 vfs_path_to_str_elements_count (const vfs_path_t * vpath, int elements_count)
685 return vfs_path_to_str_flags (vpath, elements_count, VPF_NONE);
688 /* --------------------------------------------------------------------------------------------- */
690 * Convert vfs_path_t to string representation.
692 * @param vpath pointer to vfs_path_t object
694 * @return pointer to newly created string.
697 char *
698 vfs_path_to_str (const vfs_path_t * vpath)
700 return vfs_path_to_str_elements_count (vpath, vfs_path_elements_count (vpath));
703 /* --------------------------------------------------------------------------------------------- */
705 * Split path string to path elements with flags for change parce process.
707 * @param path_str VFS-path
708 * @param flags flags for parser
710 * @return pointer to newly created vfs_path_t object with filled path elements array.
713 vfs_path_t *
714 vfs_path_from_str_flags (const char *path_str, vfs_path_flag_t flags)
716 vfs_path_t *vpath;
717 char *path;
719 if (path_str == NULL)
720 return NULL;
722 if ((flags & VPF_NO_CANON) == 0)
723 path = vfs_canon (path_str);
724 else
725 path = g_strdup (path_str);
727 if (path == NULL)
728 return NULL;
730 if ((flags & VPF_USE_DEPRECATED_PARSER) != 0 && vfs_path_is_str_path_deprecated (path))
731 vpath = vfs_path_from_str_deprecated_parser (path, flags);
732 else
733 vpath = vfs_path_from_str_uri_parser (path, flags);
735 g_free (path);
737 return vpath;
740 /* --------------------------------------------------------------------------------------------- */
742 * Split path string to path elements.
744 * @param path_str VFS-path
746 * @return pointer to newly created vfs_path_t object with filled path elements array.
749 vfs_path_t *
750 vfs_path_from_str (const char *path_str)
752 return vfs_path_from_str_flags (path_str, VPF_NONE);
755 /* --------------------------------------------------------------------------------------------- */
757 * Create new vfs_path_t object.
759 * @return pointer to newly created vfs_path_t object.
762 vfs_path_t *
763 vfs_path_new (void)
765 vfs_path_t *vpath;
767 vpath = g_new0 (vfs_path_t, 1);
768 vpath->path = g_array_new (FALSE, TRUE, sizeof (vfs_path_element_t *));
770 return vpath;
773 /* --------------------------------------------------------------------------------------------- */
775 * Get count of path elements.
777 * @param vpath pointer to vfs_path_t object
779 * @return count of path elements.
783 vfs_path_elements_count (const vfs_path_t * vpath)
785 return (vpath != NULL && vpath->path != NULL) ? vpath->path->len : 0;
788 /* --------------------------------------------------------------------------------------------- */
790 * Add vfs_path_element_t object to end of list in vfs_path_t object
791 * @param vpath pointer to vfs_path_t object
792 * @param path_element pointer to vfs_path_element_t object
795 void
796 vfs_path_add_element (const vfs_path_t * vpath, const vfs_path_element_t * path_element)
798 g_array_append_val (vpath->path, path_element);
801 /* --------------------------------------------------------------------------------------------- */
803 * Get one path element by index.
805 * @param vpath pointer to vfs_path_t object
806 * @param element_index element index. May have negative value (in this case count was started at the end of list).
808 * @return path element.
811 const vfs_path_element_t *
812 vfs_path_get_by_index (const vfs_path_t * vpath, int element_index)
814 if (element_index < 0)
815 element_index += vfs_path_elements_count (vpath);
817 if (element_index < 0)
818 vfs_die ("vfs_path_get_by_index: incorrect index!");
820 return g_array_index (vpath->path, vfs_path_element_t *, element_index);
823 /* --------------------------------------------------------------------------------------------- */
825 * Clone one path element
827 * @param element pointer to vfs_path_element_t object
829 * @return Newly allocated path element
832 vfs_path_element_t *
833 vfs_path_element_clone (const vfs_path_element_t * element)
835 vfs_path_element_t *new_element = g_new0 (vfs_path_element_t, 1);
836 memcpy (new_element, element, sizeof (vfs_path_element_t));
838 new_element->user = g_strdup (element->user);
839 new_element->password = g_strdup (element->password);
840 new_element->host = g_strdup (element->host);
841 new_element->path = g_strdup (element->path);
842 new_element->encoding = g_strdup (element->encoding);
843 if (vfs_path_element_need_cleanup_converter (element) && new_element->encoding != NULL)
844 new_element->dir.converter = str_crt_conv_from (new_element->encoding);
845 new_element->vfs_prefix = g_strdup (element->vfs_prefix);
847 return new_element;
850 /* --------------------------------------------------------------------------------------------- */
852 * Free one path element.
854 * @param element pointer to vfs_path_element_t object
858 void
859 vfs_path_element_free (vfs_path_element_t * element)
861 if (element == NULL)
862 return;
864 g_free (element->user);
865 g_free (element->password);
866 g_free (element->host);
867 g_free (element->path);
868 g_free (element->encoding);
869 g_free (element->vfs_prefix);
871 if (vfs_path_element_need_cleanup_converter (element))
873 str_close_conv (element->dir.converter);
876 g_free (element);
879 /* --------------------------------------------------------------------------------------------- */
881 * Clone path
883 * @param vpath pointer to vfs_path_t object
885 * @return Newly allocated path object
888 vfs_path_t *
889 vfs_path_clone (const vfs_path_t * vpath)
891 vfs_path_t *new_vpath;
892 int vpath_element_index;
894 if (vpath == NULL)
895 return NULL;
897 new_vpath = vfs_path_new ();
898 new_vpath->relative = vpath->relative;
900 for (vpath_element_index = 0; vpath_element_index < vfs_path_elements_count (vpath);
901 vpath_element_index++)
903 vfs_path_element_t *path_element;
905 path_element = vfs_path_element_clone (vfs_path_get_by_index (vpath, vpath_element_index));
906 g_array_append_val (new_vpath->path, path_element);
909 return new_vpath;
912 /* --------------------------------------------------------------------------------------------- */
914 * Free vfs_path_t object.
916 * @param vpath pointer to vfs_path_t object
920 void
921 vfs_path_free (vfs_path_t * vpath)
923 int vpath_element_index;
925 if (vpath == NULL)
926 return;
928 for (vpath_element_index = 0; vpath_element_index < vfs_path_elements_count (vpath);
929 vpath_element_index++)
931 vfs_path_element_t *path_element;
933 path_element = (vfs_path_element_t *) vfs_path_get_by_index (vpath, vpath_element_index);
934 vfs_path_element_free (path_element);
937 g_array_free (vpath->path, TRUE);
938 g_free (vpath);
941 /* --------------------------------------------------------------------------------------------- */
943 * Remove one path element by index
945 * @param vpath pointer to vfs_path_t object
946 * @param element_index element index. May have negative value (in this case count was started at the end of list).
950 void
951 vfs_path_remove_element_by_index (vfs_path_t * vpath, int element_index)
953 vfs_path_element_t *element;
955 if ((vpath == NULL) || (vfs_path_elements_count (vpath) == 1))
956 return;
958 if (element_index < 0)
959 element_index = vfs_path_elements_count (vpath) + element_index;
961 element = (vfs_path_element_t *) vfs_path_get_by_index (vpath, element_index);
962 vpath->path = g_array_remove_index (vpath->path, element_index);
963 vfs_path_element_free (element);
966 /* --------------------------------------------------------------------------------------------- */
967 /** Return VFS class for the given prefix */
969 struct vfs_class *
970 vfs_prefix_to_class (const char *prefix)
972 guint i;
974 /* Avoid first class (localfs) that would accept any prefix */
975 for (i = 1; i < vfs__classes_list->len; i++)
977 struct vfs_class *vfs;
979 vfs = (struct vfs_class *) g_ptr_array_index (vfs__classes_list, i);
980 if (vfs->which != NULL)
982 if (vfs->which (vfs, prefix) == -1)
983 continue;
984 return vfs;
987 if (vfs->prefix != NULL && strncmp (prefix, vfs->prefix, strlen (vfs->prefix)) == 0)
988 return vfs;
991 return NULL;
994 /* --------------------------------------------------------------------------------------------- */
996 * Check if need cleanup charset converter for vfs_path_element_t
998 * @param element part of path
1000 * @return TRUE if need cleanup converter or FALSE otherwise
1003 gboolean
1004 vfs_path_element_need_cleanup_converter (const vfs_path_element_t * element)
1006 return (element->dir.converter != str_cnv_from_term && element->dir.converter != INVALID_CONV);
1009 /* --------------------------------------------------------------------------------------------- */
1011 * Serialize vfs_path_t object to string
1013 * @param vpath data for serialization
1014 * @param error contain pointer to object for handle error code and message
1016 * @return serialized vpath as newly allocated string
1019 char *
1020 vfs_path_serialize (const vfs_path_t * vpath, GError ** error)
1022 mc_config_t *cpath = mc_config_init (NULL);
1023 ssize_t element_index;
1024 char *ret_value;
1026 if ((vpath == NULL) || (vfs_path_elements_count (vpath) == 0))
1028 g_set_error (error, MC_ERROR, -1, "vpath object is empty");
1029 return NULL;
1032 for (element_index = 0; element_index < vfs_path_elements_count (vpath); element_index++)
1034 char *groupname;
1035 const vfs_path_element_t *element;
1037 groupname = g_strdup_printf ("path-element-%zd", element_index);
1038 element = vfs_path_get_by_index (vpath, element_index);
1039 /* convert one element to config group */
1041 mc_config_set_string_raw (cpath, groupname, "path", element->path);
1042 mc_config_set_string_raw (cpath, groupname, "class-name", element->class->name);
1043 mc_config_set_string_raw (cpath, groupname, "encoding", element->encoding);
1045 mc_config_set_string_raw (cpath, groupname, "vfs_prefix", element->vfs_prefix);
1047 mc_config_set_string_raw (cpath, groupname, "user", element->user);
1048 mc_config_set_string_raw (cpath, groupname, "password", element->password);
1049 mc_config_set_string_raw (cpath, groupname, "host", element->host);
1050 if (element->port != 0)
1051 mc_config_set_int (cpath, groupname, "port", element->port);
1053 g_free (groupname);
1056 ret_value = mc_serialize_config (cpath, error);
1057 mc_config_deinit (cpath);
1058 return ret_value;
1061 /* --------------------------------------------------------------------------------------------- */
1063 * Deserialize string to vfs_path_t object
1065 * @param data data for serialization
1066 * @param error contain pointer to object for handle error code and message
1068 * @return newly allocated vfs_path_t object
1071 vfs_path_t *
1072 vfs_path_deserialize (const char *data, GError ** error)
1074 mc_config_t *cpath = mc_deserialize_config (data, error);
1075 size_t element_index = 0;
1076 vfs_path_t *vpath;
1078 if (cpath == NULL)
1079 return NULL;
1081 vpath = vfs_path_new ();
1083 while (TRUE)
1085 vfs_path_element_t *element;
1086 char *cfg_value;
1087 char *groupname;
1089 groupname = g_strdup_printf ("path-element-%zd", element_index);
1090 if (!mc_config_has_group (cpath, groupname))
1092 g_free (groupname);
1093 break;
1096 element = g_new0 (vfs_path_element_t, 1);
1098 cfg_value = mc_config_get_string_raw (cpath, groupname, "class-name", NULL);
1099 element->class = vfs_get_class_by_name (cfg_value);
1100 if (element->class == NULL)
1102 g_free (element);
1103 vfs_path_free (vpath);
1104 g_set_error (error, MC_ERROR, -1, "Unable to find VFS class by name '%s'", cfg_value);
1105 g_free (cfg_value);
1106 mc_config_deinit (cpath);
1107 return NULL;
1109 g_free (cfg_value);
1111 element->path = mc_config_get_string_raw (cpath, groupname, "path", NULL);
1112 element->encoding = mc_config_get_string_raw (cpath, groupname, "encoding", NULL);
1113 element->dir.converter =
1114 (element->encoding != NULL) ? str_crt_conv_from (element->encoding) : INVALID_CONV;
1116 element->vfs_prefix = mc_config_get_string_raw (cpath, groupname, "vfs_prefix", NULL);
1118 element->user = mc_config_get_string_raw (cpath, groupname, "user", NULL);
1119 element->password = mc_config_get_string_raw (cpath, groupname, "password", NULL);
1120 element->host = mc_config_get_string_raw (cpath, groupname, "host", NULL);
1121 element->port = mc_config_get_int (cpath, groupname, "port", 0);
1123 vpath->path = g_array_append_val (vpath->path, element);
1125 g_free (groupname);
1126 element_index++;
1129 mc_config_deinit (cpath);
1130 if (vfs_path_elements_count (vpath) == 0)
1132 vfs_path_free (vpath);
1133 g_set_error (error, MC_ERROR, -1, "No any path elements found");
1134 return NULL;
1137 return vpath;
1140 /* --------------------------------------------------------------------------------------------- */
1142 * Build vfs_path_t object from arguments.
1144 * @param ... path tokens, terminated by NULL
1146 * @return newly allocated vfs_path_t object
1149 vfs_path_t *
1150 vfs_path_build_filename (const char *first_element, ...)
1152 va_list args;
1153 char *str_path;
1154 vfs_path_t *vpath;
1156 if (first_element == NULL)
1157 return NULL;
1159 va_start (args, first_element);
1160 str_path = mc_build_filenamev (first_element, args);
1161 va_end (args);
1162 vpath = vfs_path_from_str (str_path);
1163 g_free (str_path);
1164 return vpath;
1167 /* --------------------------------------------------------------------------------------------- */
1169 * Append tokens to path object
1171 * @param vpath path object
1172 * @param ... NULL-terminated strings
1174 * @return newly allocated path object
1177 vfs_path_t *
1178 vfs_path_append_new (const vfs_path_t * vpath, const char *first_element, ...)
1180 va_list args;
1181 char *str_path, *result_str;
1182 vfs_path_t *ret_vpath;
1184 if (vpath == NULL || first_element == NULL)
1185 return NULL;
1187 va_start (args, first_element);
1188 str_path = mc_build_filenamev (first_element, args);
1189 va_end (args);
1191 result_str = vfs_path_to_str (vpath);
1192 ret_vpath = vfs_path_build_filename (result_str, str_path, NULL);
1193 g_free (result_str);
1194 g_free (str_path);
1196 return ret_vpath;
1200 /* --------------------------------------------------------------------------------------------- */
1203 * Append vpath_t tokens to path object
1205 * @param ... NULL-terminated vpath objects
1207 * @return newly allocated path object
1210 vfs_path_t *
1211 vfs_path_append_vpath_new (const vfs_path_t * first_vpath, ...)
1213 va_list args;
1214 vfs_path_t *ret_vpath;
1215 const vfs_path_t *current_vpath = first_vpath;
1217 if (first_vpath == NULL)
1218 return NULL;
1220 ret_vpath = vfs_path_new ();
1222 va_start (args, first_vpath);
1225 int vindex;
1227 for (vindex = 0; vindex < vfs_path_elements_count (current_vpath); vindex++)
1229 vfs_path_element_t *path_element;
1231 path_element = vfs_path_element_clone (vfs_path_get_by_index (current_vpath, vindex));
1232 g_array_append_val (ret_vpath->path, path_element);
1234 current_vpath = va_arg (args, const vfs_path_t *);
1236 while (current_vpath != NULL);
1237 va_end (args);
1239 return ret_vpath;
1242 /* --------------------------------------------------------------------------------------------- */
1244 * get tockens count in path.
1246 * @param vpath path object
1248 * @return count of tokens
1251 size_t
1252 vfs_path_tokens_count (const vfs_path_t * vpath)
1254 size_t count_tokens = 0;
1255 int element_index;
1257 if (vpath == NULL)
1258 return 0;
1260 for (element_index = 0; element_index < vfs_path_elements_count (vpath); element_index++)
1262 const vfs_path_element_t *element;
1263 char **path_tokens, **iterator;
1265 element = vfs_path_get_by_index (vpath, element_index);
1266 path_tokens = iterator = g_strsplit (element->path, PATH_SEP_STR, -1);
1268 while (*iterator != NULL)
1270 if (**iterator != '\0')
1271 count_tokens++;
1272 iterator++;
1274 g_strfreev (path_tokens);
1276 return count_tokens;
1279 /* --------------------------------------------------------------------------------------------- */
1281 * Get subpath by tokens
1283 * @param vpath path object
1284 * @param start_position first token for got/ Started from 0.
1285 * If negative, then position will be relative to end of path
1286 * @param length count of tokens
1288 * @return newly allocated string with path tokens separated by slash
1291 char *
1292 vfs_path_tokens_get (const vfs_path_t * vpath, ssize_t start_position, ssize_t length)
1294 GString *ret_tokens, *element_tokens;
1295 int element_index;
1296 size_t tokens_count = vfs_path_tokens_count (vpath);
1298 if (vpath == NULL)
1299 return NULL;
1301 if (length == 0)
1302 length = tokens_count;
1304 if (length < 0)
1305 length = tokens_count + length;
1307 if (start_position < 0)
1308 start_position = (ssize_t) tokens_count + start_position;
1310 if (start_position < 0)
1311 return NULL;
1313 if (start_position >= (ssize_t) tokens_count)
1314 return NULL;
1316 if (start_position + (ssize_t) length > (ssize_t) tokens_count)
1317 length = tokens_count - start_position;
1319 ret_tokens = g_string_sized_new (32);
1320 element_tokens = g_string_sized_new (32);
1322 for (element_index = 0; element_index < vfs_path_elements_count (vpath); element_index++)
1324 const vfs_path_element_t *element;
1325 char **path_tokens, **iterator;
1327 g_string_assign (element_tokens, "");
1328 element = vfs_path_get_by_index (vpath, element_index);
1329 path_tokens = iterator = g_strsplit (element->path, PATH_SEP_STR, -1);
1331 while (*iterator != NULL)
1333 if (**iterator != '\0')
1335 if (start_position == 0)
1337 if (length == 0)
1339 vfs_path_tokens_add_class_info (element, ret_tokens, element_tokens);
1340 g_string_free (element_tokens, TRUE);
1341 g_strfreev (path_tokens);
1342 return g_string_free (ret_tokens, FALSE);
1344 length--;
1345 if (element_tokens->len != 0)
1346 g_string_append_c (element_tokens, PATH_SEP);
1347 g_string_append (element_tokens, *iterator);
1349 else
1350 start_position--;
1352 iterator++;
1354 g_strfreev (path_tokens);
1355 vfs_path_tokens_add_class_info (element, ret_tokens, element_tokens);
1358 g_string_free (element_tokens, TRUE);
1359 return g_string_free (ret_tokens, !(start_position == 0 && length == 0));
1362 /* --------------------------------------------------------------------------------------------- */
1364 * Get subpath by tokens
1366 * @param vpath path object
1367 * @param start_position first token for got/ Started from 0.
1368 * If negative, then position will be relative to end of path
1369 * @param length count of tokens
1371 * @return newly allocated path object with path tokens separated by slash
1374 vfs_path_t *
1375 vfs_path_vtokens_get (const vfs_path_t * vpath, ssize_t start_position, ssize_t length)
1377 char *str_tokens;
1378 vfs_path_t *ret_vpath = NULL;
1380 str_tokens = vfs_path_tokens_get (vpath, start_position, length);
1381 if (str_tokens != NULL)
1383 ret_vpath = vfs_path_from_str_flags (str_tokens, VPF_NO_CANON);
1384 g_free (str_tokens);
1386 return ret_vpath;
1389 /* --------------------------------------------------------------------------------------------- */
1391 * Build URL parameters (such as user:pass@host:port) from one path element object
1393 * @param element path element
1395 * @return newly allocated string
1398 char *
1399 vfs_path_build_url_params_str (const vfs_path_element_t * element, gboolean keep_password)
1401 GString *buffer;
1403 if (element == NULL)
1404 return NULL;
1406 buffer = g_string_new ("");
1408 if (element->user != NULL)
1409 g_string_append (buffer, element->user);
1411 if (element->password != NULL && keep_password)
1413 g_string_append_c (buffer, ':');
1414 g_string_append (buffer, element->password);
1417 if (element->host != NULL)
1419 if ((element->user != NULL) || (element->password != NULL))
1420 g_string_append_c (buffer, '@');
1421 if (element->ipv6)
1422 g_string_append_c (buffer, '[');
1423 g_string_append (buffer, element->host);
1424 if (element->ipv6)
1425 g_string_append_c (buffer, ']');
1428 if ((element->port) != 0 && (element->host != NULL))
1430 g_string_append_c (buffer, ':');
1431 g_string_append_printf (buffer, "%d", element->port);
1434 return g_string_free (buffer, FALSE);
1437 /* --------------------------------------------------------------------------------------------- */
1439 * Compare two path objects as strings
1441 * @param vpath1 first path object
1442 * @param vpath2 second vpath object
1444 * @return integer value like to strcmp.
1448 vfs_path_cmp (const vfs_path_t * vpath1, const vfs_path_t * vpath2)
1450 char *path1;
1451 char *path2;
1452 int ret_val;
1454 if (vpath1 == NULL || vpath2 == NULL)
1455 return -1;
1457 path1 = vfs_path_to_str (vpath1);
1458 path2 = vfs_path_to_str (vpath2);
1460 ret_val = strcmp (path1, path2);
1462 g_free (path1);
1463 g_free (path2);
1465 return ret_val;
1468 /* --------------------------------------------------------------------------------------------- */
1470 * Compare two path objects as strings
1472 * @param vpath1 first path object
1473 * @param vpath2 second vpath object
1474 * @param len number of first 'len' characters
1476 * @return integer value like to strcmp.
1480 vfs_path_ncmp (const vfs_path_t * vpath1, const vfs_path_t * vpath2, size_t len)
1482 char *path1;
1483 char *path2;
1484 int ret_val;
1486 if (vpath1 == NULL || vpath2 == NULL)
1487 return -1;
1489 path1 = vfs_path_to_str (vpath1);
1490 path2 = vfs_path_to_str (vpath2);
1492 ret_val = strncmp (path1, path2, len);
1494 g_free (path1);
1495 g_free (path2);
1497 return ret_val;
1500 /* --------------------------------------------------------------------------------------------- */
1502 * Calculate path length in string representation
1504 * @param vpath path object
1506 * @return length of path
1509 size_t
1510 vfs_path_len (const vfs_path_t * vpath)
1512 char *path;
1513 size_t ret_val;
1515 if (vpath == NULL)
1516 return 0;
1518 path = vfs_path_to_str (vpath);
1519 ret_val = strlen (path);
1520 g_free (path);
1521 return ret_val;
1524 /* --------------------------------------------------------------------------------------------- */
1526 * Convert relative vpath object to absolute
1528 * @param vpath path object
1530 * @return absolute path object
1533 vfs_path_t *
1534 vfs_path_to_absolute (const vfs_path_t * vpath)
1536 vfs_path_t *absolute_vpath;
1537 char *path_str;
1539 if (!vpath->relative)
1540 return vfs_path_clone (vpath);
1542 path_str = vfs_path_to_str (vpath);
1543 absolute_vpath = vfs_path_from_str (path_str);
1544 g_free (path_str);
1545 return absolute_vpath;
1548 /* --------------------------------------------------------------------------------------------- */