|
Subversion 1.6.16
|
|
Subversion 1.6.16
|
Properties. More...
Functions | |
| svn_error_t * | svn_client_propset3 (svn_commit_info_t **commit_info_p, const char *propname, const svn_string_t *propval, const char *target, svn_depth_t depth, svn_boolean_t skip_checks, svn_revnum_t base_revision_for_url, const apr_array_header_t *changelists, const apr_hash_t *revprop_table, svn_client_ctx_t *ctx, apr_pool_t *pool) |
| Set propname to propval on target. | |
| svn_error_t * | svn_client_propset2 (const char *propname, const svn_string_t *propval, const char *target, svn_boolean_t recurse, svn_boolean_t skip_checks, svn_client_ctx_t *ctx, apr_pool_t *pool) |
Like svn_client_propset3(), but with base_revision_for_url always SVN_INVALID_REVNUM; commit_info_p always NULL; changelists always NULL; revprop_table always NULL; and depth set according to recurse: if recurse is TRUE, depth is svn_depth_infinity, else svn_depth_empty. | |
| svn_error_t * | svn_client_propset (const char *propname, const svn_string_t *propval, const char *target, svn_boolean_t recurse, apr_pool_t *pool) |
| Like svn_client_propset2(), but with skip_checks always FALSE and a newly created ctx. | |
| svn_error_t * | svn_client_revprop_set2 (const char *propname, const svn_string_t *propval, const svn_string_t *original_propval, const char *URL, const svn_opt_revision_t *revision, svn_revnum_t *set_rev, svn_boolean_t force, svn_client_ctx_t *ctx, apr_pool_t *pool) |
| Set propname to propval on revision revision in the repository represented by URL. | |
| svn_error_t * | svn_client_revprop_set (const char *propname, const svn_string_t *propval, const char *URL, const svn_opt_revision_t *revision, svn_revnum_t *set_rev, svn_boolean_t force, svn_client_ctx_t *ctx, apr_pool_t *pool) |
Similar to svn_client_revprop_set2(), but with original_propval always NULL. | |
| svn_error_t * | svn_client_propget3 (apr_hash_t **props, const char *propname, const char *target, const svn_opt_revision_t *peg_revision, const svn_opt_revision_t *revision, svn_revnum_t *actual_revnum, svn_depth_t depth, const apr_array_header_t *changelists, svn_client_ctx_t *ctx, apr_pool_t *pool) |
Set *props to a hash table whose keys are `char *' paths, prefixed by target (a working copy path or a URL), of items on which property propname is set, and whose values are `svn_string_t *' representing the property value for propname at that path. | |
| svn_error_t * | svn_client_propget2 (apr_hash_t **props, const char *propname, const char *target, const svn_opt_revision_t *peg_revision, const svn_opt_revision_t *revision, svn_boolean_t recurse, svn_client_ctx_t *ctx, apr_pool_t *pool) |
Similar to svn_client_propget3(), except that actual_revnum and changelists are always NULL, and depth is set according to recurse: if recurse is TRUE, then depth is svn_depth_infinity, else svn_depth_empty. | |
| svn_error_t * | svn_client_propget (apr_hash_t **props, const char *propname, const char *target, const svn_opt_revision_t *revision, svn_boolean_t recurse, svn_client_ctx_t *ctx, apr_pool_t *pool) |
| Similar to svn_client_propget2(), except that peg_revision is always the same as revision. | |
| svn_error_t * | svn_client_revprop_get (const char *propname, svn_string_t **propval, const char *URL, const svn_opt_revision_t *revision, svn_revnum_t *set_rev, svn_client_ctx_t *ctx, apr_pool_t *pool) |
| Set *propval to the value of propname on revision revision in the repository represented by URL. | |
| svn_error_t * | svn_client_proplist3 (const char *target, const svn_opt_revision_t *peg_revision, const svn_opt_revision_t *revision, svn_depth_t depth, const apr_array_header_t *changelists, svn_proplist_receiver_t receiver, void *receiver_baton, svn_client_ctx_t *ctx, apr_pool_t *pool) |
| Invoke receiver with receiver_baton to return the regular properies of target, a URL or working copy path. | |
| svn_error_t * | svn_client_proplist2 (apr_array_header_t **props, const char *target, const svn_opt_revision_t *peg_revision, const svn_opt_revision_t *revision, svn_boolean_t recurse, svn_client_ctx_t *ctx, apr_pool_t *pool) |
Similar to svn_client_proplist3(), except the properties are returned as an array of svn_client_proplist_item_t * structures instead of by invoking the receiver function, there's no support for changelists filtering, and recurse is used instead of a svn_depth_t parameter (FALSE corresponds to svn_depth_empty, and TRUE to svn_depth_infinity). | |
| svn_error_t * | svn_client_proplist (apr_array_header_t **props, const char *target, const svn_opt_revision_t *revision, svn_boolean_t recurse, svn_client_ctx_t *ctx, apr_pool_t *pool) |
| Similar to svn_client_proplist2(), except that peg_revision is always the same as revision. | |
| svn_error_t * | svn_client_revprop_list (apr_hash_t **props, const char *URL, const svn_opt_revision_t *revision, svn_revnum_t *set_rev, svn_client_ctx_t *ctx, apr_pool_t *pool) |
| Set *props to a hash of the revision props attached to revision in the repository represented by URL. | |
Properties.
Note that certain svn-controlled properties must always have their values set and stored in UTF8 with LF line endings. When retrieving these properties, callers must convert the values back to native locale and native line-endings before displaying them to the user. For help with this task, see svn_prop_needs_translation(), svn_subst_translate_string(), and svn_subst_detranslate_string().
| svn_error_t* svn_client_propget | ( | apr_hash_t ** | props, |
| const char * | propname, | ||
| const char * | target, | ||
| const svn_opt_revision_t * | revision, | ||
| svn_boolean_t | recurse, | ||
| svn_client_ctx_t * | ctx, | ||
| apr_pool_t * | pool | ||
| ) |
Similar to svn_client_propget2(), except that peg_revision is always the same as revision.
| svn_error_t* svn_client_propget2 | ( | apr_hash_t ** | props, |
| const char * | propname, | ||
| const char * | target, | ||
| const svn_opt_revision_t * | peg_revision, | ||
| const svn_opt_revision_t * | revision, | ||
| svn_boolean_t | recurse, | ||
| svn_client_ctx_t * | ctx, | ||
| apr_pool_t * | pool | ||
| ) |
Similar to svn_client_propget3(), except that actual_revnum and changelists are always NULL, and depth is set according to recurse: if recurse is TRUE, then depth is svn_depth_infinity, else svn_depth_empty.
| svn_error_t* svn_client_propget3 | ( | apr_hash_t ** | props, |
| const char * | propname, | ||
| const char * | target, | ||
| const svn_opt_revision_t * | peg_revision, | ||
| const svn_opt_revision_t * | revision, | ||
| svn_revnum_t * | actual_revnum, | ||
| svn_depth_t | depth, | ||
| const apr_array_header_t * | changelists, | ||
| svn_client_ctx_t * | ctx, | ||
| apr_pool_t * | pool | ||
| ) |
Set *props to a hash table whose keys are `char *' paths, prefixed by target (a working copy path or a URL), of items on which property propname is set, and whose values are `svn_string_t *' representing the property value for propname at that path.
Allocate *props, its keys, and its values in pool.
Don't store any path, not even target, if it does not have a property named propname.
If revision->kind is svn_opt_revision_unspecified, then: get properties from the working copy if target is a working copy path, or from the repository head if target is a URL. Else get the properties as of revision. The actual node revision selected is determined by the path as it exists in peg_revision. If peg_revision->kind is svn_opt_revision_unspecified, then it defaults to svn_opt_revision_head for URLs or svn_opt_revision_working for WC targets. Use the authentication baton in ctx for authentication if contacting the repository. If actual_revnum is not NULL, the actual revision number used for the fetch is stored in *actual_revnum.
If depth is svn_depth_empty, fetch the property from target only; if svn_depth_files, fetch from target and its file children (if any); if svn_depth_immediates, from target and all of its immediate children (both files and directories); if svn_depth_infinity, from target and everything beneath it.
changelists is an array of const char * changelist names, used as a restrictive filter on items whose properties are set; that is, don't set properties on any item unless it's a member of one of those changelists. If changelists is empty (or altogether NULL), no changelist filtering occurs.
If error, don't touch *props, otherwise *props is a hash table even if empty.
| svn_error_t* svn_client_proplist | ( | apr_array_header_t ** | props, |
| const char * | target, | ||
| const svn_opt_revision_t * | revision, | ||
| svn_boolean_t | recurse, | ||
| svn_client_ctx_t * | ctx, | ||
| apr_pool_t * | pool | ||
| ) |
Similar to svn_client_proplist2(), except that peg_revision is always the same as revision.
| svn_error_t* svn_client_proplist2 | ( | apr_array_header_t ** | props, |
| const char * | target, | ||
| const svn_opt_revision_t * | peg_revision, | ||
| const svn_opt_revision_t * | revision, | ||
| svn_boolean_t | recurse, | ||
| svn_client_ctx_t * | ctx, | ||
| apr_pool_t * | pool | ||
| ) |
Similar to svn_client_proplist3(), except the properties are returned as an array of svn_client_proplist_item_t * structures instead of by invoking the receiver function, there's no support for changelists filtering, and recurse is used instead of a svn_depth_t parameter (FALSE corresponds to svn_depth_empty, and TRUE to svn_depth_infinity).
| svn_error_t* svn_client_proplist3 | ( | const char * | target, |
| const svn_opt_revision_t * | peg_revision, | ||
| const svn_opt_revision_t * | revision, | ||
| svn_depth_t | depth, | ||
| const apr_array_header_t * | changelists, | ||
| svn_proplist_receiver_t | receiver, | ||
| void * | receiver_baton, | ||
| svn_client_ctx_t * | ctx, | ||
| apr_pool_t * | pool | ||
| ) |
Invoke receiver with receiver_baton to return the regular properies of target, a URL or working copy path.
receiver will be called for each path encountered.
If revision->kind is svn_opt_revision_unspecified, then get properties from the working copy, if target is a working copy path, or from the repository head if target is a URL. Else get the properties as of revision. The actual node revision selected is determined by the path as it exists in peg_revision. If peg_revision->kind is svn_opt_revision_unspecified, then it defaults to svn_opt_revision_head for URLs or svn_opt_revision_working for WC targets. Use the authentication baton cached in ctx for authentication if contacting the repository.
If depth is svn_depth_empty, list only the properties of target itself. If depth is svn_depth_files, and target is a directory, list the properties of target and its file entries. If svn_depth_immediates, list the properties of its immediate file and directory entries. If svn_depth_infinity, list the properties of its file entries and recurse (with svn_depth_infinity) on directory entries. svn_depth_unknown is equivalent to svn_depth_empty. All other values produce undefined results.
changelists is an array of const char * changelist names, used as a restrictive filter on items whose properties are set; that is, don't set properties on any item unless it's a member of one of those changelists. If changelists is empty (or altogether NULL), no changelist filtering occurs.
If target is not found, return the error SVN_ERR_ENTRY_NOT_FOUND.
| svn_error_t* svn_client_propset | ( | const char * | propname, |
| const svn_string_t * | propval, | ||
| const char * | target, | ||
| svn_boolean_t | recurse, | ||
| apr_pool_t * | pool | ||
| ) |
Like svn_client_propset2(), but with skip_checks always FALSE and a newly created ctx.
| svn_error_t* svn_client_propset2 | ( | const char * | propname, |
| const svn_string_t * | propval, | ||
| const char * | target, | ||
| svn_boolean_t | recurse, | ||
| svn_boolean_t | skip_checks, | ||
| svn_client_ctx_t * | ctx, | ||
| apr_pool_t * | pool | ||
| ) |
Like svn_client_propset3(), but with base_revision_for_url always SVN_INVALID_REVNUM; commit_info_p always NULL; changelists always NULL; revprop_table always NULL; and depth set according to recurse: if recurse is TRUE, depth is svn_depth_infinity, else svn_depth_empty.
| svn_error_t* svn_client_propset3 | ( | svn_commit_info_t ** | commit_info_p, |
| const char * | propname, | ||
| const svn_string_t * | propval, | ||
| const char * | target, | ||
| svn_depth_t | depth, | ||
| svn_boolean_t | skip_checks, | ||
| svn_revnum_t | base_revision_for_url, | ||
| const apr_array_header_t * | changelists, | ||
| const apr_hash_t * | revprop_table, | ||
| svn_client_ctx_t * | ctx, | ||
| apr_pool_t * | pool | ||
| ) |
Set propname to propval on target.
A propval of NULL will delete the property.
If depth is svn_depth_empty, set the property on target only; if svn_depth_files, set it on target and its file children (if any); if svn_depth_immediates, on target and all of its immediate children (both files and directories); if svn_depth_infinity, on target and everything beneath it.
The target may only be an URL if base_revision_for_url is not SVN_INVALID_REVNUM; in this case, the property will only be set if it has not changed since revision base_revision_for_url. base_revision_for_url must be SVN_INVALID_REVNUM if target is not an URL. depth deeper than svn_depth_empty is not supported on URLs. The authentication baton in ctx and ctx->log_msg_func3/ctx->log_msg_baton3 will be used to immediately attempt to commit the property change in the repository. If the commit succeeds, allocate (in pool) and populate *commit_info_p.
If propname is an svn-controlled property (i.e. prefixed with SVN_PROP_PREFIX), then the caller is responsible for ensuring that the value is UTF8-encoded and uses LF line-endings.
If skip_checks is TRUE, do no validity checking. But if skip_checks is FALSE, and propname is not a valid property for target, return an error, either SVN_ERR_ILLEGAL_TARGET (if the property is not appropriate for target), or SVN_ERR_BAD_MIME_TYPE (if propname is "svn:mime-type", but propval is not a valid mime-type).
changelists is an array of const char * changelist names, used as a restrictive filter on items whose properties are set; that is, don't set properties on any item unless it's a member of one of those changelists. If changelists is empty (or altogether NULL), no changelist filtering occurs.
If non-NULL, revprop_table is a hash table holding additional, custom revision properties (const char * names mapped to svn_string_t * values) to be set on the new revision in the event that this is a committing operation. This table cannot contain any standard Subversion properties.
If ctx->cancel_func is non-NULL, invoke it passing ctx->cancel_baton at various places during the operation.
Use pool for all memory allocation.
| svn_error_t* svn_client_revprop_get | ( | const char * | propname, |
| svn_string_t ** | propval, | ||
| const char * | URL, | ||
| const svn_opt_revision_t * | revision, | ||
| svn_revnum_t * | set_rev, | ||
| svn_client_ctx_t * | ctx, | ||
| apr_pool_t * | pool | ||
| ) |
Set *propval to the value of propname on revision revision in the repository represented by URL.
Use the authentication baton in ctx for authentication, and pool for all memory allocation. Return the actual rev queried in *set_rev.
Note that unlike its cousin svn_client_propget(), this routine doesn't affect the working copy at all; it's a pure network operation that queries an *unversioned* property attached to a revision. This can query log messages, dates, authors, and the like.
| svn_error_t* svn_client_revprop_list | ( | apr_hash_t ** | props, |
| const char * | URL, | ||
| const svn_opt_revision_t * | revision, | ||
| svn_revnum_t * | set_rev, | ||
| svn_client_ctx_t * | ctx, | ||
| apr_pool_t * | pool | ||
| ) |
Set *props to a hash of the revision props attached to revision in the repository represented by URL.
Use the authentication baton cached in ctx for authentication, and pool for all memory allocation. Return the actual rev queried in *set_rev.
The allocated hash maps (const char *) property names to (svn_string_t *) property values.
Note that unlike its cousin svn_client_proplist(), this routine doesn't read a working copy at all; it's a pure network operation that reads *unversioned* properties attached to a revision.
| svn_error_t* svn_client_revprop_set | ( | const char * | propname, |
| const svn_string_t * | propval, | ||
| const char * | URL, | ||
| const svn_opt_revision_t * | revision, | ||
| svn_revnum_t * | set_rev, | ||
| svn_boolean_t | force, | ||
| svn_client_ctx_t * | ctx, | ||
| apr_pool_t * | pool | ||
| ) |
Similar to svn_client_revprop_set2(), but with original_propval always NULL.
| svn_error_t* svn_client_revprop_set2 | ( | const char * | propname, |
| const svn_string_t * | propval, | ||
| const svn_string_t * | original_propval, | ||
| const char * | URL, | ||
| const svn_opt_revision_t * | revision, | ||
| svn_revnum_t * | set_rev, | ||
| svn_boolean_t | force, | ||
| svn_client_ctx_t * | ctx, | ||
| apr_pool_t * | pool | ||
| ) |
Set propname to propval on revision revision in the repository represented by URL.
Use the authentication baton in ctx for authentication, and pool for all memory allocation. Return the actual rev affected in *set_rev. A propval of NULL will delete the property.
If original_propval is non-NULL, then just before setting the new value, check that the old value matches original_propval; if they do not match, return the error SVN_ERR_RA_OUT_OF_DATE. This is to help clients support interactive editing of revprops: without this check, the window during which the property may change underneath the user is as wide as the amount of time the user spends editing the property. With this check, the window is reduced to a small, constant amount of time right before we set the new value. (To check that an old value is still non-existent, set original_propval->data to NULL, and original_propval->len is ignored.)
If force is TRUE, allow newlines in the author property.
If propname is an svn-controlled property (i.e. prefixed with SVN_PROP_PREFIX), then the caller is responsible for ensuring that the value UTF8-encoded and uses LF line-endings.
Note that unlike its cousin svn_client_propset3(), this routine doesn't affect the working copy at all; it's a pure network operation that changes an *unversioned* property attached to a revision. This can be used to tweak log messages, dates, authors, and the like. Be careful: it's a lossy operation.
ctx->notify_func2 and ctx->notify_baton2 are the notification functions and baton which are called upon successful setting of the property.
Also note that unless the administrator creates a pre-revprop-change hook in the repository, this feature will fail.
1.7.3
