2 * list-cmd.c -- list a URL
4 * ====================================================================
5 * Licensed to the Apache Software Foundation (ASF) under one
6 * or more contributor license agreements. See the NOTICE file
7 * distributed with this work for additional information
8 * regarding copyright ownership. The ASF licenses this file
9 * to you under the Apache License, Version 2.0 (the
10 * "License"); you may not use this file except in compliance
11 * with the License. You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing,
16 * software distributed under the License is distributed on an
17 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18 * KIND, either express or implied. See the License for the
19 * specific language governing permissions and limitations
21 * ====================================================================
24 #include "svn_cmdline.h"
25 #include "svn_client.h"
26 #include "svn_error.h"
27 #include "svn_pools.h"
30 #include "svn_dirent_uri.h"
37 #include "svn_private_config.h"
41 /* Baton used when printing directory entries. */
43 svn_boolean_t verbose;
44 svn_client_ctx_t *ctx;
46 /* To keep track of last seen external information. */
47 const char *last_external_parent_url;
48 const char *last_external_target;
49 svn_boolean_t in_external;
52 /* Field flags required for this function */
53 static const apr_uint32_t print_dirent_fields = SVN_DIRENT_KIND;
54 static const apr_uint32_t print_dirent_fields_verbose = (
55 SVN_DIRENT_KIND | SVN_DIRENT_SIZE | SVN_DIRENT_TIME |
56 SVN_DIRENT_CREATED_REV | SVN_DIRENT_LAST_AUTHOR);
58 /* This implements the svn_client_list_func2_t API, printing a single
59 directory entry in text format. */
61 print_dirent(void *baton,
63 const svn_dirent_t *dirent,
64 const svn_lock_t *lock,
66 const char *external_parent_url,
67 const char *external_target,
68 apr_pool_t *scratch_pool)
70 struct print_baton *pb = baton;
71 const char *entryname;
72 static const char *time_format_long = NULL;
73 static const char *time_format_short = NULL;
75 SVN_ERR_ASSERT((external_parent_url == NULL && external_target == NULL) ||
76 (external_parent_url && external_target));
78 if (time_format_long == NULL)
79 time_format_long = _("%b %d %H:%M");
80 if (time_format_short == NULL)
81 time_format_short = _("%b %d %Y");
83 if (pb->ctx->cancel_func)
84 SVN_ERR(pb->ctx->cancel_func(pb->ctx->cancel_baton));
86 if (strcmp(path, "") == 0)
88 if (dirent->kind == svn_node_file)
89 entryname = svn_dirent_basename(abs_path, scratch_pool);
93 /* Don't bother to list if no useful information will be shown. */
99 if (external_parent_url && external_target)
101 if ((pb->last_external_parent_url == NULL
102 && pb->last_external_target == NULL)
103 || (strcmp(pb->last_external_parent_url, external_parent_url) != 0
104 || strcmp(pb->last_external_target, external_target) != 0))
106 SVN_ERR(svn_cmdline_printf(scratch_pool,
107 _("Listing external '%s'"
108 " defined on '%s':\n"),
110 external_parent_url));
112 pb->last_external_parent_url = external_parent_url;
113 pb->last_external_target = external_target;
119 apr_time_t now = apr_time_now();
120 apr_time_exp_t exp_time;
121 apr_status_t apr_err;
124 const char *sizestr, *utf8_timestr;
126 /* svn_time_to_human_cstring gives us something *way* too long
127 to use for this, so we have to roll our own. We include
128 the year if the entry's time is not within half a year. */
129 apr_time_exp_lt(&exp_time, dirent->time);
130 if (apr_time_sec(now - dirent->time) < (365 * 86400 / 2)
131 && apr_time_sec(dirent->time - now) < (365 * 86400 / 2))
133 apr_err = apr_strftime(timestr, &size, sizeof(timestr),
134 time_format_long, &exp_time);
138 apr_err = apr_strftime(timestr, &size, sizeof(timestr),
139 time_format_short, &exp_time);
142 /* if that failed, just zero out the string and print nothing */
146 /* we need it in UTF-8. */
147 SVN_ERR(svn_utf_cstring_to_utf8(&utf8_timestr, timestr, scratch_pool));
149 sizestr = apr_psprintf(scratch_pool, "%" SVN_FILESIZE_T_FMT,
152 return svn_cmdline_printf
153 (scratch_pool, "%7ld %-8.8s %c %10s %12s %s%s\n",
155 dirent->last_author ? dirent->last_author : " ? ",
157 (dirent->kind == svn_node_file) ? sizestr : "",
160 (dirent->kind == svn_node_dir) ? "/" : "");
164 return svn_cmdline_printf(scratch_pool, "%s%s\n", entryname,
165 (dirent->kind == svn_node_dir)
170 /* Field flags required for this function */
171 static const apr_uint32_t print_dirent_xml_fields = (
172 SVN_DIRENT_KIND | SVN_DIRENT_SIZE | SVN_DIRENT_TIME |
173 SVN_DIRENT_CREATED_REV | SVN_DIRENT_LAST_AUTHOR);
174 /* This implements the svn_client_list_func2_t API, printing a single dirent
177 print_dirent_xml(void *baton,
179 const svn_dirent_t *dirent,
180 const svn_lock_t *lock,
181 const char *abs_path,
182 const char *external_parent_url,
183 const char *external_target,
184 apr_pool_t *scratch_pool)
186 struct print_baton *pb = baton;
187 const char *entryname;
188 svn_stringbuf_t *sb = svn_stringbuf_create_empty(scratch_pool);
190 SVN_ERR_ASSERT((external_parent_url == NULL && external_target == NULL) ||
191 (external_parent_url && external_target));
193 if (strcmp(path, "") == 0)
195 if (dirent->kind == svn_node_file)
196 entryname = svn_dirent_basename(abs_path, scratch_pool);
198 /* Don't bother to list if no useful information will be shown. */
204 if (pb->ctx->cancel_func)
205 SVN_ERR(pb->ctx->cancel_func(pb->ctx->cancel_baton));
207 if (external_parent_url && external_target)
209 if ((pb->last_external_parent_url == NULL
210 && pb->last_external_target == NULL)
211 || (strcmp(pb->last_external_parent_url, external_parent_url) != 0
212 || strcmp(pb->last_external_target, external_target) != 0))
216 /* The external item being listed is different from the previous
217 one, so close the tag. */
218 svn_xml_make_close_tag(&sb, scratch_pool, "external");
219 pb->in_external = FALSE;
222 svn_xml_make_open_tag(&sb, scratch_pool, svn_xml_normal, "external",
223 "parent_url", external_parent_url,
224 "target", external_target,
227 pb->last_external_parent_url = external_parent_url;
228 pb->last_external_target = external_target;
229 pb->in_external = TRUE;
233 svn_xml_make_open_tag(&sb, scratch_pool, svn_xml_normal, "entry",
234 "kind", svn_cl__node_kind_str_xml(dirent->kind),
237 svn_cl__xml_tagged_cdata(&sb, scratch_pool, "name", entryname);
239 if (dirent->kind == svn_node_file)
241 svn_cl__xml_tagged_cdata
242 (&sb, scratch_pool, "size",
243 apr_psprintf(scratch_pool, "%" SVN_FILESIZE_T_FMT, dirent->size));
246 svn_xml_make_open_tag(&sb, scratch_pool, svn_xml_normal, "commit",
248 apr_psprintf(scratch_pool, "%ld", dirent->created_rev),
250 svn_cl__xml_tagged_cdata(&sb, scratch_pool, "author", dirent->last_author);
252 svn_cl__xml_tagged_cdata(&sb, scratch_pool, "date",
253 svn_time_to_cstring(dirent->time, scratch_pool));
254 svn_xml_make_close_tag(&sb, scratch_pool, "commit");
258 svn_xml_make_open_tag(&sb, scratch_pool, svn_xml_normal, "lock",
260 svn_cl__xml_tagged_cdata(&sb, scratch_pool, "token", lock->token);
261 svn_cl__xml_tagged_cdata(&sb, scratch_pool, "owner", lock->owner);
262 svn_cl__xml_tagged_cdata(&sb, scratch_pool, "comment", lock->comment);
263 svn_cl__xml_tagged_cdata(&sb, scratch_pool, "created",
264 svn_time_to_cstring(lock->creation_date,
266 if (lock->expiration_date != 0)
267 svn_cl__xml_tagged_cdata(&sb, scratch_pool, "expires",
269 (lock->expiration_date, scratch_pool));
270 svn_xml_make_close_tag(&sb, scratch_pool, "lock");
273 svn_xml_make_close_tag(&sb, scratch_pool, "entry");
275 return svn_cl__error_checked_fputs(sb->data, stdout);
279 /* This implements the `svn_opt_subcommand_t' interface. */
281 svn_cl__list(apr_getopt_t *os,
285 svn_cl__opt_state_t *opt_state = ((svn_cl__cmd_baton_t *) baton)->opt_state;
286 svn_client_ctx_t *ctx = ((svn_cl__cmd_baton_t *) baton)->ctx;
287 apr_array_header_t *targets;
289 apr_pool_t *subpool = svn_pool_create(pool);
290 apr_uint32_t dirent_fields;
291 struct print_baton pb;
292 svn_boolean_t seen_nonexistent_target = FALSE;
294 svn_error_t *externals_err = SVN_NO_ERROR;
295 struct svn_cl__check_externals_failed_notify_baton nwb;
297 SVN_ERR(svn_cl__args_to_target_array_print_reserved(&targets, os,
301 /* Add "." if user passed 0 arguments */
302 svn_opt_push_implicit_dot_target(targets, pool);
306 /* The XML output contains all the information, so "--verbose"
308 if (opt_state->verbose)
309 return svn_error_create(SVN_ERR_CL_ARG_PARSING_ERROR, NULL,
310 _("'verbose' option invalid in XML mode"));
312 /* If output is not incremental, output the XML header and wrap
313 everything in a top-level element. This makes the output in
314 its entirety a well-formed XML document. */
315 if (! opt_state->incremental)
316 SVN_ERR(svn_cl__xml_print_header("lists", pool));
320 if (opt_state->incremental)
321 return svn_error_create(SVN_ERR_CL_ARG_PARSING_ERROR, NULL,
322 _("'incremental' option only valid in XML "
327 dirent_fields = print_dirent_xml_fields;
328 else if (opt_state->verbose)
329 dirent_fields = print_dirent_fields_verbose;
331 dirent_fields = print_dirent_fields;
334 pb.verbose = opt_state->verbose;
336 if (opt_state->depth == svn_depth_unknown)
337 opt_state->depth = svn_depth_immediates;
339 if (opt_state->include_externals)
341 nwb.wrapped_func = ctx->notify_func2;
342 nwb.wrapped_baton = ctx->notify_baton2;
343 nwb.had_externals_error = FALSE;
344 ctx->notify_func2 = svn_cl__check_externals_failed_notify_wrapper;
345 ctx->notify_baton2 = &nwb;
348 /* For each target, try to list it. */
349 for (i = 0; i < targets->nelts; i++)
351 const char *target = APR_ARRAY_IDX(targets, i, const char *);
352 const char *truepath;
353 svn_opt_revision_t peg_revision;
354 apr_array_header_t *patterns = NULL;
357 /* Initialize the following variables for
358 every list target. */
359 pb.last_external_parent_url = NULL;
360 pb.last_external_target = NULL;
361 pb.in_external = FALSE;
363 svn_pool_clear(subpool);
365 SVN_ERR(svn_cl__check_cancel(ctx->cancel_baton));
367 /* Get peg revisions. */
368 SVN_ERR(svn_opt_parse_path(&peg_revision, &truepath, target,
373 svn_stringbuf_t *sb = svn_stringbuf_create_empty(pool);
374 svn_xml_make_open_tag(&sb, pool, svn_xml_normal, "list",
375 "path", truepath[0] == '\0' ? "." : truepath,
377 SVN_ERR(svn_cl__error_checked_fputs(sb->data, stdout));
380 if (opt_state->search_patterns)
382 patterns = apr_array_make(subpool, 4, sizeof(const char *));
383 for (k = 0; k < opt_state->search_patterns->nelts; ++k)
385 apr_array_header_t *pattern_group
386 = APR_ARRAY_IDX(opt_state->search_patterns, k,
387 apr_array_header_t *);
390 /* Should never fail but ... */
391 if (pattern_group->nelts != 1)
392 return svn_error_create(SVN_ERR_CL_ARG_PARSING_ERROR, NULL,
393 _("'search-and' option is not supported"));
395 pattern = APR_ARRAY_IDX(pattern_group, 0, const char *);
397 /* As we currently can't pass glob patterns via the Windows
398 CLI, fall back to sub-string search. */
399 pattern = apr_psprintf(subpool, "*%s*", pattern);
401 APR_ARRAY_PUSH(patterns, const char *) = pattern;
405 err = svn_client_list4(truepath, &peg_revision,
406 &(opt_state->start_revision), patterns,
409 (opt_state->xml || opt_state->verbose),
410 opt_state->include_externals,
411 opt_state->xml ? print_dirent_xml : print_dirent,
416 /* If one of the targets is a non-existent URL or wc-entry,
417 don't bail out. Just warn and move on to the next target. */
418 if (err->apr_err == SVN_ERR_WC_PATH_NOT_FOUND ||
419 err->apr_err == SVN_ERR_FS_NOT_FOUND)
420 svn_handle_warning2(stderr, err, "svn: ");
422 return svn_error_trace(err);
424 svn_error_clear(err);
426 seen_nonexistent_target = TRUE;
431 svn_stringbuf_t *sb = svn_stringbuf_create_empty(pool);
435 /* close the final external item's tag */
436 svn_xml_make_close_tag(&sb, pool, "external");
437 pb.in_external = FALSE;
440 svn_xml_make_close_tag(&sb, pool, "list");
441 SVN_ERR(svn_cl__error_checked_fputs(sb->data, stdout));
445 svn_pool_destroy(subpool);
447 if (opt_state->include_externals && nwb.had_externals_error)
449 externals_err = svn_error_create(SVN_ERR_CL_ERROR_PROCESSING_EXTERNALS,
451 _("Failure occurred processing one or "
452 "more externals definitions"));
455 if (opt_state->xml && ! opt_state->incremental)
456 SVN_ERR(svn_cl__xml_print_footer("lists", pool));
458 if (seen_nonexistent_target)
459 err = svn_error_create(SVN_ERR_ILLEGAL_TARGET, NULL,
460 _("Could not list all targets because some targets don't exist"));
464 return svn_error_compose_create(externals_err, err);