Commit 2a7d224f by Russell Belfer

Extend public filter api with filter lists

This moves the git_filter_list into the public API so that users
can create, apply, and dispose of filter lists.  This allows more
granular application of filters to user data outside of libgit2
internals.

This also converts all the internal usage of filters to the public
APIs along with a few small tweaks to make it easier to use the
public git_buffer stuff alongside the internal git_buf.
parent 974774c7
...@@ -21,17 +21,17 @@ GIT_BEGIN_DECL ...@@ -21,17 +21,17 @@ GIT_BEGIN_DECL
/** /**
* A data buffer for exporting data from libgit2 * A data buffer for exporting data from libgit2
* *
* There are a number of places where libgit2 wants to return an allocated * Sometimes libgit2 wants to return an allocated data buffer to the
* data buffer to the caller and have the caller take ownership of that * caller and have the caller take responsibility for freeing that memory.
* allocated memory. This can be awkward if the caller does not have easy * This can be awkward if the caller does not have easy access to the same
* access to the same allocation functions that libgit2 is using. In those * allocation functions that libgit2 is using. In those cases, libgit2
* cases, libgit2 will instead fill in a `git_buffer` and the caller can * will instead fill in a `git_buffer` and the caller can use
* use `git_buffer_free()` to release it when they are done. * `git_buffer_free()` to release it when they are done.
* *
* * `ptr` refers to the start of the allocated memory. * * `ptr` refers to the start of the allocated memory.
* * `size` contains the size of the data in `ptr` that is actually used. * * `size` contains the size of the data in `ptr` that is actually used.
* * `available` refers to the known total amount of allocated memory in * * `available` refers to the known total amount of allocated memory. It
* cases where it is larger than the `size` actually in use. * may be larger than the `size` actually in use.
* *
* In a few cases, for uniformity and simplicity, an API may populate a * In a few cases, for uniformity and simplicity, an API may populate a
* `git_buffer` with data that should *not* be freed (i.e. the lifetime of * `git_buffer` with data that should *not* be freed (i.e. the lifetime of
...@@ -79,6 +79,17 @@ GIT_EXTERN(void) git_buffer_free(git_buffer *buffer); ...@@ -79,6 +79,17 @@ GIT_EXTERN(void) git_buffer_free(git_buffer *buffer);
*/ */
GIT_EXTERN(int) git_buffer_resize(git_buffer *buffer, size_t want_size); GIT_EXTERN(int) git_buffer_resize(git_buffer *buffer, size_t want_size);
/**
* Set buffer to a copy of some raw data.
*
* @param buffer The buffer to set
* @param data The data to copy into the buffer
* @param datalen The length of the data to copy into the buffer
* @return 0 on success, negative error code on allocation failure
*/
GIT_EXTERN(int) git_buffer_copy(
git_buffer *buffer, const void *data, size_t datalen);
GIT_END_DECL GIT_END_DECL
/** @} */ /** @} */
......
...@@ -29,10 +29,10 @@ GIT_BEGIN_DECL ...@@ -29,10 +29,10 @@ GIT_BEGIN_DECL
* change is being applied. * change is being applied.
*/ */
typedef enum { typedef enum {
GIT_FILTER_SMUDGE = 0, GIT_FILTER_TO_WORKTREE = 0,
GIT_FILTER_TO_WORKTREE = GIT_FILTER_SMUDGE, GIT_FILTER_SMUDGE = GIT_FILTER_TO_WORKTREE,
GIT_FILTER_CLEAN = 1, GIT_FILTER_TO_ODB = 1,
GIT_FILTER_TO_ODB = GIT_FILTER_CLEAN, GIT_FILTER_CLEAN = GIT_FILTER_TO_ODB,
} git_filter_mode_t; } git_filter_mode_t;
/** /**
...@@ -50,10 +50,28 @@ typedef enum { ...@@ -50,10 +50,28 @@ typedef enum {
*/ */
typedef struct git_filter git_filter; typedef struct git_filter git_filter;
/**
* List of filters to be applied
*
* This represents a list of filters to be applied to a file / blob. You
* can build the list with one call, apply it with another, and dispose it
* with a third. In typical usage, there are not many occasions where a
* git_filter_list is needed directly since the library will generally
* handle conversions for you, but it can be convenient to be able to
* build and apply the list sometimes.
*/
typedef struct git_filter_list git_filter_list;
/**
* Look up a filter by name
*/
GIT_EXTERN(git_filter *) git_filter_lookup(const char *name); GIT_EXTERN(git_filter *) git_filter_lookup(const char *name);
#define GIT_FILTER_CRLF "crlf" #define GIT_FILTER_CRLF "crlf"
/**
* Apply a single filter to a buffer of data
*/
GIT_EXTERN(int) git_filter_apply_to_buffer( GIT_EXTERN(int) git_filter_apply_to_buffer(
git_buffer *out, git_buffer *out,
git_filter *filter, git_filter *filter,
...@@ -61,6 +79,74 @@ GIT_EXTERN(int) git_filter_apply_to_buffer( ...@@ -61,6 +79,74 @@ GIT_EXTERN(int) git_filter_apply_to_buffer(
const char *as_path, const char *as_path,
git_filter_mode_t mode); git_filter_mode_t mode);
/**
* Load the filter list for a given path.
*
* This will return 0 (success) but set the output git_filter_list to NULL
* if no filters are requested for the given file.
*
* @param filters Output newly created git_filter_list (or NULL)
* @param repo Repository object that contains `path`
* @param path Relative path of the file to be filtered
* @param mode Filtering direction (WT->ODB or ODB->WT)
* @return 0 on success (which could still return NULL if no filters are
* needed for the requested file), <0 on error
*/
GIT_EXTERN(int) git_filter_list_load(
git_filter_list **filters,
git_repository *repo,
const char *path,
git_filter_mode_t mode);
/**
* Apply filter list to a data buffer.
*
* See `git2/buffer.h` for background on `git_buffer` objects.
*
* If the `in` buffer refers to data managed by libgit2
* (i.e. `in->available` is not zero), then it will be overwritten when
* applying the filters. If not, then it will be left untouched.
*
* If there are no filters to apply (or `filters` is NULL), then the `out`
* buffer will reference the `in` buffer data (with `available` set to
* zero) instead of allocating data. This keeps allocations to a minimum,
* but it means you have to be careful about freeing the `in` data.
*
* @param out Buffer to store the result of the filtering
* @param filters A loaded git_filter_list (or NULL)
* @param in Buffer containing the data to filter
* @return 0 on success, an error code otherwise
*/
GIT_EXTERN(int) git_filter_list_apply_to_data(
git_buffer *out,
git_filter_list *filters,
git_buffer *in);
/**
* Apply filter list to the contents of a file on disk
*/
GIT_EXTERN(int) git_filter_list_apply_to_file(
git_buffer *out,
git_filter_list *filters,
git_repository *repo,
const char *path);
/**
* Apply filter list to the contents of a blob
*/
GIT_EXTERN(int) git_filter_list_apply_to_blob(
git_buffer *out,
git_filter_list *filters,
git_blob *blob);
/**
* Free a git_filter_list
*
* @param filters A git_filter_list created by `git_filter_list_load`
*/
GIT_EXTERN(void) git_filter_list_free(git_filter_list *filters);
GIT_END_DECL GIT_END_DECL
/** @} */ /** @} */
......
...@@ -46,6 +46,11 @@ GIT_EXTERN(uint16_t) git_filter_source_filemode(const git_filter_source *src); ...@@ -46,6 +46,11 @@ GIT_EXTERN(uint16_t) git_filter_source_filemode(const git_filter_source *src);
*/ */
GIT_EXTERN(const git_oid *) git_filter_source_id(const git_filter_source *src); GIT_EXTERN(const git_oid *) git_filter_source_id(const git_filter_source *src);
/**
* Get the git_filter_mode_t to be applied
*/
GIT_EXTERN(git_filter_mode_t) git_filter_source_mode(const git_filter_source *src);
/* /*
* struct git_filter * struct git_filter
* *
...@@ -73,7 +78,6 @@ typedef void (*git_filter_shutdown_fn)(git_filter *self); ...@@ -73,7 +78,6 @@ typedef void (*git_filter_shutdown_fn)(git_filter *self);
typedef int (*git_filter_check_fn)( typedef int (*git_filter_check_fn)(
git_filter *self, git_filter *self,
void **payload, /* points to NULL ptr on entry, may be set */ void **payload, /* points to NULL ptr on entry, may be set */
git_filter_mode_t mode,
const git_filter_source *src, const git_filter_source *src,
const char **attr_values); const char **attr_values);
...@@ -83,7 +87,6 @@ typedef int (*git_filter_check_fn)( ...@@ -83,7 +87,6 @@ typedef int (*git_filter_check_fn)(
typedef int (*git_filter_apply_fn)( typedef int (*git_filter_apply_fn)(
git_filter *self, git_filter *self,
void **payload, /* may be read and/or set */ void **payload, /* may be read and/or set */
git_filter_mode_t mode,
git_buffer *to, git_buffer *to,
const git_buffer *from, const git_buffer *from,
const git_filter_source *src); const git_filter_source *src);
...@@ -105,14 +108,11 @@ typedef void (*git_filter_cleanup_fn)( ...@@ -105,14 +108,11 @@ typedef void (*git_filter_cleanup_fn)(
* *
* `version` should be set to GIT_FILTER_VERSION * `version` should be set to GIT_FILTER_VERSION
* *
* `attributes` is a list of attributes to check on a file to see if the * `attributes` is a whitespace-separated list of attribute names to check
* filter applies. The format is a whitespace-delimited list of names * for this filter (e.g. "eol crlf text"). If the attribute name is bare,
* (like "eol crlf text"). Each name may have an optional value that will * it will be simply loaded and passed to the `check` callback. If it has
* be tested even without a `check` callback. If the value does not * a value (i.e. "name=value"), the attribute must match that value for
* match, the filter will be skipped. The values are specified as in a * the filter to be applied.
* .gitattributes file (e.g. "myattr=foobar" or "myattr" or "-myattr").
* If a check function is supplied, then the values of the attributes will
* be passed to that function.
* *
* `initialize` is an optional callback invoked before a filter is first * `initialize` is an optional callback invoked before a filter is first
* used. It will be called once at most. * used. It will be called once at most.
......
...@@ -111,26 +111,18 @@ static int write_file_filtered( ...@@ -111,26 +111,18 @@ static int write_file_filtered(
git_filter_list *fl) git_filter_list *fl)
{ {
int error; int error;
git_buf source = GIT_BUF_INIT; git_buffer tgt = GIT_BUFFER_INIT;
git_buf dest = GIT_BUF_INIT;
if ((error = git_futils_readbuffer(&source, full_path)) < 0) error = git_filter_list_apply_to_file(&tgt, fl, NULL, full_path);
return error;
error = git_filter_list_apply(&dest, &source, fl);
/* Free the source as soon as possible. This can be big in memory,
* and we don't want to ODB write to choke */
git_buf_free(&source);
/* Write the file to disk if it was properly filtered */ /* Write the file to disk if it was properly filtered */
if (!error) { if (!error) {
*size = dest.size; *size = tgt.size;
error = git_odb_write(oid, odb, dest.ptr, dest.size, GIT_OBJ_BLOB); error = git_odb_write(oid, odb, tgt.ptr, tgt.size, GIT_OBJ_BLOB);
} }
git_buf_free(&dest); git_buffer_free(&tgt);
return error; return error;
} }
...@@ -329,8 +321,9 @@ int git_blob_is_binary(git_blob *blob) ...@@ -329,8 +321,9 @@ int git_blob_is_binary(git_blob *blob)
assert(blob); assert(blob);
content.ptr = blob->odb_object->buffer; content.ptr = blob->odb_object->buffer;
content.size = min(blob->odb_object->cached.size, 4000); content.size = min(blob->odb_object->cached.size, 4000);
content.asize = 0;
return git_buf_text_is_binary(&content); return git_buf_text_is_binary(&content);
} }
...@@ -342,46 +335,20 @@ int git_blob_filtered_content( ...@@ -342,46 +335,20 @@ int git_blob_filtered_content(
int check_for_binary_data) int check_for_binary_data)
{ {
int error = 0; int error = 0;
git_buf filtered = GIT_BUF_INIT, unfiltered = GIT_BUF_INIT;
git_filter_list *fl = NULL; git_filter_list *fl = NULL;
assert(blob && as_path && out); assert(blob && as_path && out);
/* Create a fake git_buf from the blob raw data... */ if (check_for_binary_data && git_blob_is_binary(blob))
filtered.ptr = (void *)git_blob_rawcontent(blob);
filtered.size = (size_t)git_blob_rawsize(blob);
filtered.asize = 0;
if (check_for_binary_data && git_buf_text_is_binary(&filtered))
return 0; return 0;
error = git_filter_list_load( if (!(error = git_filter_list_load(
&fl, git_blob_owner(blob), as_path, GIT_FILTER_TO_WORKTREE); &fl, git_blob_owner(blob), as_path, GIT_FILTER_TO_WORKTREE))) {
if (error < 0)
return error;
if (fl != NULL) { error = git_filter_list_apply_to_blob(out, fl, blob);
if (out->ptr && out->available) {
filtered.ptr = out->ptr;
filtered.size = out->size;
filtered.asize = out->available;
} else {
git_buf_init(&filtered, filtered.size + 1);
}
if (!(error = git_blob__getbuf(&unfiltered, blob)))
error = git_filter_list_apply(&filtered, &unfiltered, fl);
git_filter_list_free(fl); git_filter_list_free(fl);
git_buf_free(&unfiltered);
}
if (!error) {
out->ptr = filtered.ptr;
out->size = filtered.size;
out->available = filtered.asize;
} }
return error; return error;
} }
...@@ -501,7 +501,8 @@ void git_buffer_free(git_buffer *buffer) ...@@ -501,7 +501,8 @@ void git_buffer_free(git_buffer *buffer)
git__memzero(buffer, sizeof(*buffer)); git__memzero(buffer, sizeof(*buffer));
} }
int git_buffer_resize(git_buffer *buffer, size_t want_size) static int git_buffer__resize(
git_buffer *buffer, size_t want_size, int preserve_data)
{ {
int non_allocated_buffer = 0; int non_allocated_buffer = 0;
char *new_ptr; char *new_ptr;
...@@ -514,7 +515,7 @@ int git_buffer_resize(git_buffer *buffer, size_t want_size) ...@@ -514,7 +515,7 @@ int git_buffer_resize(git_buffer *buffer, size_t want_size)
if (non_allocated_buffer && !want_size) if (non_allocated_buffer && !want_size)
want_size = buffer->size; want_size = buffer->size;
if (buffer->available <= want_size) if (buffer->available >= want_size)
return 0; return 0;
if (non_allocated_buffer) { if (non_allocated_buffer) {
...@@ -530,7 +531,7 @@ int git_buffer_resize(git_buffer *buffer, size_t want_size) ...@@ -530,7 +531,7 @@ int git_buffer_resize(git_buffer *buffer, size_t want_size)
new_ptr = git__realloc(new_ptr, want_size); new_ptr = git__realloc(new_ptr, want_size);
GITERR_CHECK_ALLOC(new_ptr); GITERR_CHECK_ALLOC(new_ptr);
if (non_allocated_buffer) if (non_allocated_buffer && preserve_data)
memcpy(new_ptr, buffer->ptr, buffer->size); memcpy(new_ptr, buffer->ptr, buffer->size);
buffer->ptr = new_ptr; buffer->ptr = new_ptr;
...@@ -538,3 +539,19 @@ int git_buffer_resize(git_buffer *buffer, size_t want_size) ...@@ -538,3 +539,19 @@ int git_buffer_resize(git_buffer *buffer, size_t want_size)
return 0; return 0;
} }
int git_buffer_resize(git_buffer *buffer, size_t want_size)
{
return git_buffer__resize(buffer, want_size, true);
}
int git_buffer_copy(
git_buffer *buffer, const void *data, size_t datalen)
{
if (git_buffer__resize(buffer, datalen, false) < 0)
return -1;
memcpy(buffer->ptr, data, datalen);
buffer->size = datalen;
return 0;
}
...@@ -176,6 +176,11 @@ int git_buf_splice( ...@@ -176,6 +176,11 @@ int git_buf_splice(
size_t nb_to_insert); size_t nb_to_insert);
GIT_INLINE(bool) git_buffer_is_allocated(const git_buffer *buffer)
{
return (buffer->ptr != NULL && buffer->available > 0);
}
#define GIT_BUF_FROM_BUFFER(buffer) \ #define GIT_BUF_FROM_BUFFER(buffer) \
{ (buffer)->ptr, (buffer)->available, (buffer)->size } { (buffer)->ptr, (buffer)->available, (buffer)->size }
......
...@@ -678,19 +678,20 @@ fail: ...@@ -678,19 +678,20 @@ fail:
static int buffer_to_file( static int buffer_to_file(
struct stat *st, struct stat *st,
git_buf *buffer, git_buffer *buffer,
const char *path, const char *path,
mode_t dir_mode, mode_t dir_mode,
int file_open_flags, int file_open_flags,
mode_t file_mode) mode_t file_mode)
{ {
int error; int error;
git_buf buf = GIT_BUF_FROM_BUFFER(buffer);
if ((error = git_futils_mkpath2file(path, dir_mode)) < 0) if ((error = git_futils_mkpath2file(path, dir_mode)) < 0)
return error; return error;
if ((error = git_futils_writebuffer( if ((error = git_futils_writebuffer(
buffer, path, file_open_flags, file_mode)) < 0) &buf, path, file_open_flags, file_mode)) < 0)
return error; return error;
if (st != NULL && (error = p_stat(path, st)) < 0) if (st != NULL && (error = p_stat(path, st)) < 0)
...@@ -712,39 +713,26 @@ static int blob_content_to_file( ...@@ -712,39 +713,26 @@ static int blob_content_to_file(
{ {
int error = 0; int error = 0;
mode_t file_mode = opts->file_mode ? opts->file_mode : entry_filemode; mode_t file_mode = opts->file_mode ? opts->file_mode : entry_filemode;
git_buf unfiltered = GIT_BUF_INIT, filtered = GIT_BUF_INIT; git_buffer out = GIT_BUFFER_INIT;
git_filter_list *fl = NULL; git_filter_list *fl = NULL;
/* Create a fake git_buf from the blob raw data... */ if (!opts->disable_filters && !git_blob_is_binary(blob))
filtered.ptr = (void *)git_blob_rawcontent(blob);
filtered.size = (size_t)git_blob_rawsize(blob);
if (!opts->disable_filters && !git_buf_text_is_binary(&filtered)) {
error = git_filter_list_load( error = git_filter_list_load(
&fl, git_blob_owner(blob), path, GIT_FILTER_TO_WORKTREE); &fl, git_blob_owner(blob), path, GIT_FILTER_TO_WORKTREE);
}
if (fl != NULL) { if (!error)
/* reset 'filtered' so it can be a filter target */ error = git_filter_list_apply_to_blob(&out, fl, blob);
git_buf_init(&filtered, 0);
if (!(error = git_blob__getbuf(&unfiltered, blob))) { git_filter_list_free(fl);
error = git_filter_list_apply(&filtered, &unfiltered, fl);
git_buf_free(&unfiltered);
}
git_filter_list_free(fl); if (!error) {
} error = buffer_to_file(
st, &out, path, opts->dir_mode, opts->file_open_flags, file_mode);
if (!error &&
!(error = buffer_to_file(
st, &filtered, path, opts->dir_mode,
opts->file_open_flags, file_mode)))
st->st_mode = entry_filemode; st->st_mode = entry_filemode;
if (filtered.asize != 0) git_buffer_free(&out);
git_buf_free(&filtered); }
return error; return error;
} }
......
...@@ -8,6 +8,7 @@ ...@@ -8,6 +8,7 @@
#include "git2/attr.h" #include "git2/attr.h"
#include "git2/blob.h" #include "git2/blob.h"
#include "git2/index.h" #include "git2/index.h"
#include "git2/sys/filter.h"
#include "common.h" #include "common.h"
#include "fileops.h" #include "fileops.h"
...@@ -249,7 +250,6 @@ static int crlf_apply_to_workdir( ...@@ -249,7 +250,6 @@ static int crlf_apply_to_workdir(
static int crlf_check( static int crlf_check(
git_filter *self, git_filter *self,
void **payload, /* points to NULL ptr on entry, may be set */ void **payload, /* points to NULL ptr on entry, may be set */
git_filter_mode_t mode,
const git_filter_source *src, const git_filter_source *src,
const char **attr_values) const char **attr_values)
{ {
...@@ -257,7 +257,6 @@ static int crlf_check( ...@@ -257,7 +257,6 @@ static int crlf_check(
struct crlf_attrs ca; struct crlf_attrs ca;
GIT_UNUSED(self); GIT_UNUSED(self);
GIT_UNUSED(mode);
if (!attr_values) { if (!attr_values) {
ca.crlf_action = GIT_CRLF_GUESS; ca.crlf_action = GIT_CRLF_GUESS;
...@@ -299,14 +298,13 @@ static int crlf_check( ...@@ -299,14 +298,13 @@ static int crlf_check(
static int crlf_apply( static int crlf_apply(
git_filter *self, git_filter *self,
void **payload, /* may be read and/or set */ void **payload, /* may be read and/or set */
git_filter_mode_t mode,
git_buffer *to, git_buffer *to,
const git_buffer *from, const git_buffer *from,
const git_filter_source *src) const git_filter_source *src)
{ {
GIT_UNUSED(self); GIT_UNUSED(self);
if (mode == GIT_FILTER_SMUDGE) if (git_filter_source_mode(src) == GIT_FILTER_SMUDGE)
return crlf_apply_to_workdir(*payload, to, from); return crlf_apply_to_workdir(*payload, to, from);
else else
return crlf_apply_to_odb(*payload, to, from, src); return crlf_apply_to_odb(*payload, to, from, src);
...@@ -331,5 +329,6 @@ git_filter *git_crlf_filter_new(void) ...@@ -331,5 +329,6 @@ git_filter *git_crlf_filter_new(void)
f->f.check = crlf_check; f->f.check = crlf_check;
f->f.apply = crlf_apply; f->f.apply = crlf_apply;
f->f.cleanup = crlf_cleanup; f->f.cleanup = crlf_cleanup;
return (git_filter *)f; return (git_filter *)f;
} }
...@@ -297,8 +297,8 @@ static int diff_file_content_load_workdir_file( ...@@ -297,8 +297,8 @@ static int diff_file_content_load_workdir_file(
{ {
int error = 0; int error = 0;
git_filter_list *fl = NULL; git_filter_list *fl = NULL;
git_buf raw = GIT_BUF_INIT, filtered = GIT_BUF_INIT;
git_file fd = git_futils_open_ro(git_buf_cstr(path)); git_file fd = git_futils_open_ro(git_buf_cstr(path));
git_buf raw = GIT_BUF_INIT;
if (fd < 0) if (fd < 0)
return fd; return fd;
...@@ -326,16 +326,19 @@ static int diff_file_content_load_workdir_file( ...@@ -326,16 +326,19 @@ static int diff_file_content_load_workdir_file(
giterr_clear(); giterr_clear();
} }
if (!(error = git_futils_readbuffer_fd(&raw, fd, (size_t)fc->file->size)) && if (!(error = git_futils_readbuffer_fd(&raw, fd, (size_t)fc->file->size))) {
!(error = git_filter_list_apply(&filtered, &raw, fl))) git_buffer in = GIT_BUFFER_FROM_BUF(&raw), out = GIT_BUFFER_INIT;
{
fc->map.len = git_buf_len(&filtered); error = git_filter_list_apply_to_data(&out, fl, &in);
fc->map.data = git_buf_detach(&filtered);
fc->flags |= GIT_DIFF_FLAG__FREE_DATA; git_buffer_free(&in);
}
git_buf_free(&raw); if (!error) {
git_buf_free(&filtered); fc->map.len = out.size;
fc->map.data = out.ptr;
fc->flags |= GIT_DIFF_FLAG__FREE_DATA;
}
}
cleanup: cleanup:
git_filter_list_free(fl); git_filter_list_free(fl);
......
...@@ -10,15 +10,18 @@ ...@@ -10,15 +10,18 @@
#include "hash.h" #include "hash.h"
#include "filter.h" #include "filter.h"
#include "repository.h" #include "repository.h"
#include "git2/sys/filter.h"
#include "git2/config.h" #include "git2/config.h"
#include "blob.h" #include "blob.h"
#include "attr_file.h" #include "attr_file.h"
#include "array.h"
struct git_filter_source { struct git_filter_source {
git_repository *repo; git_repository *repo;
const char *path; const char *path;
git_oid oid; /* zero if unknown (which is likely) */ git_oid oid; /* zero if unknown (which is likely) */
uint16_t filemode; /* zero if unknown */ uint16_t filemode; /* zero if unknown */
git_filter_mode_t mode;
}; };
typedef struct { typedef struct {
...@@ -28,7 +31,6 @@ typedef struct { ...@@ -28,7 +31,6 @@ typedef struct {
struct git_filter_list { struct git_filter_list {
git_array_t(git_filter_entry) filters; git_array_t(git_filter_entry) filters;
git_filter_mode_t mode;
git_filter_source source; git_filter_source source;
char path[GIT_FLEX_ARRAY]; char path[GIT_FLEX_ARRAY];
}; };
...@@ -238,8 +240,13 @@ const git_oid *git_filter_source_id(const git_filter_source *src) ...@@ -238,8 +240,13 @@ const git_oid *git_filter_source_id(const git_filter_source *src)
return git_oid_iszero(&src->oid) ? NULL : &src->oid; return git_oid_iszero(&src->oid) ? NULL : &src->oid;
} }
git_filter_mode_t git_filter_source_mode(const git_filter_source *src)
{
return src->mode;
}
static int git_filter_list_new( static int git_filter_list_new(
git_filter_list **out, git_filter_mode_t mode, const git_filter_source *src) git_filter_list **out, const git_filter_source *src)
{ {
git_filter_list *fl = NULL; git_filter_list *fl = NULL;
size_t pathlen = src->path ? strlen(src->path) : 0; size_t pathlen = src->path ? strlen(src->path) : 0;
...@@ -247,11 +254,11 @@ static int git_filter_list_new( ...@@ -247,11 +254,11 @@ static int git_filter_list_new(
fl = git__calloc(1, sizeof(git_filter_list) + pathlen + 1); fl = git__calloc(1, sizeof(git_filter_list) + pathlen + 1);
GITERR_CHECK_ALLOC(fl); GITERR_CHECK_ALLOC(fl);
fl->mode = mode;
if (src->path) if (src->path)
memcpy(fl->path, src->path, pathlen); memcpy(fl->path, src->path, pathlen);
fl->source.repo = src->repo; fl->source.repo = src->repo;
fl->source.path = fl->path; fl->source.path = fl->path;
fl->source.mode = src->mode;
*out = fl; *out = fl;
return 0; return 0;
...@@ -316,6 +323,7 @@ int git_filter_list_load( ...@@ -316,6 +323,7 @@ int git_filter_list_load(
src.repo = repo; src.repo = repo;
src.path = path; src.path = path;
src.mode = mode;
git_vector_foreach(&git__filter_registry, idx, fdef) { git_vector_foreach(&git__filter_registry, idx, fdef) {
const char **values = NULL; const char **values = NULL;
...@@ -335,7 +343,7 @@ int git_filter_list_load( ...@@ -335,7 +343,7 @@ int git_filter_list_load(
if (fdef->filter->check) if (fdef->filter->check)
error = fdef->filter->check( error = fdef->filter->check(
fdef->filter, &payload, mode, &src, values); fdef->filter, &payload, &src, values);
git__free(values); git__free(values);
...@@ -344,7 +352,7 @@ int git_filter_list_load( ...@@ -344,7 +352,7 @@ int git_filter_list_load(
else if (error < 0) else if (error < 0)
break; break;
else { else {
if (!fl && (error = git_filter_list_new(&fl, mode, &src)) < 0) if (!fl && (error = git_filter_list_new(&fl, &src)) < 0)
return error; return error;
fe = git_array_alloc(fl->filters); fe = git_array_alloc(fl->filters);
...@@ -381,40 +389,46 @@ void git_filter_list_free(git_filter_list *fl) ...@@ -381,40 +389,46 @@ void git_filter_list_free(git_filter_list *fl)
git__free(fl); git__free(fl);
} }
int git_filter_list_apply( static int filter_list_out_buffer_from_raw(
git_buf *dest, git_buffer *out, const void *ptr, size_t size)
git_buf *source, {
git_filter_list *fl) if (git_buffer_is_allocated(out))
git_buffer_free(out);
out->ptr = (char *)ptr;
out->size = size;
out->available = 0;
return 0;
}
int git_filter_list_apply_to_data(
git_buffer *tgt, git_filter_list *fl, git_buffer *src)
{ {
int error = 0; int error = 0;
uint32_t i; uint32_t i;
unsigned int src; git_buffer *dbuffer[2], local = GIT_BUFFER_INIT;
git_buf *dbuffer[2]; unsigned int si = 0;
git_filter_entry *fe;
if (!fl) { if (!fl)
git_buf_swap(dest, source); return filter_list_out_buffer_from_raw(tgt, src->ptr, src->size);
return 0;
}
dbuffer[0] = source;
dbuffer[1] = dest;
src = 0; dbuffer[0] = src;
dbuffer[1] = tgt;
/* Pre-grow the destination buffer to more or less the size /* if `src` buffer is reallocable, then use it, otherwise copy it */
* we expect it to have */ if (!git_buffer_is_allocated(src)) {
if (git_buf_grow(dest, git_buf_len(source)) < 0) if (git_buffer_copy(&local, src->ptr, src->size) < 0)
return -1; return -1;
dbuffer[0] = &local;
}
for (i = 0; i < git_array_size(fl->filters); ++i) { for (i = 0; i < git_array_size(fl->filters); ++i) {
unsigned int dst = 1 - src; unsigned int di = 1 - si;
uint32_t fidx = (fl->source.mode == GIT_FILTER_TO_ODB) ?
git_buf_clear(dbuffer[dst]); i : git_array_size(fl->filters) - 1 - i;
git_filter_entry *fe = git_array_get(fl->filters, fidx);
fe = git_array_get( dbuffer[di]->size = 0;
fl->filters, (fl->mode == GIT_FILTER_TO_ODB) ?
i : git_array_size(fl->filters) - 1 - i);
/* Apply the filter from dbuffer[src] to the other buffer; /* Apply the filter from dbuffer[src] to the other buffer;
* if the filtering is canceled by the user mid-filter, * if the filtering is canceled by the user mid-filter,
...@@ -422,33 +436,64 @@ int git_filter_list_apply( ...@@ -422,33 +436,64 @@ int git_filter_list_apply(
* of the double buffering (so that the text goes through * of the double buffering (so that the text goes through
* cleanly). * cleanly).
*/ */
{
git_buffer srcb = GIT_BUFFER_FROM_BUF(dbuffer[src]);
git_buffer dstb = GIT_BUFFER_FROM_BUF(dbuffer[dst]);
error = fe->filter->apply( error = fe->filter->apply(
fe->filter, &fe->payload, fl->mode, &dstb, &srcb, &fl->source); fe->filter, &fe->payload, dbuffer[di], dbuffer[si], &fl->source);
if (error == GIT_ENOTFOUND) if (error == GIT_ENOTFOUND)
error = 0; error = 0;
else if (error < 0) { else if (!error)
git_buf_clear(dest); si = di; /* swap buffers */
return error; else {
} tgt->size = 0;
else { return error;
git_buf_from_buffer(dbuffer[src], &srcb);
git_buf_from_buffer(dbuffer[dst], &dstb);
src = dst;
}
} }
if (git_buf_oom(dbuffer[dst]))
return -1;
} }
/* Ensure that the output ends up in dbuffer[1] (i.e. the dest) */ /* Ensure that the output ends up in dbuffer[1] (i.e. the dest) */
if (src != 1) if (si != 1) {
git_buf_swap(dest, source); git_buffer sw = *dbuffer[1];
*dbuffer[1] = *dbuffer[0];
*dbuffer[0] = sw;
}
git_buffer_free(&local); /* don't leak if we allocated locally */
return 0; return 0;
} }
int git_filter_list_apply_to_file(
git_buffer *out,
git_filter_list *filters,
git_repository *repo,
const char *path)
{
int error;
const char *base = repo ? git_repository_workdir(repo) : NULL;
git_buf abspath = GIT_BUF_INIT, raw = GIT_BUF_INIT;
if (!(error = git_path_join_unrooted(&abspath, path, base, NULL)) &&
!(error = git_futils_readbuffer(&raw, abspath.ptr)))
{
git_buffer in = GIT_BUFFER_FROM_BUF(&raw);
error = git_filter_list_apply_to_data(out, filters, &in);
git_buffer_free(&in);
}
git_buf_free(&abspath);
return error;
}
int git_filter_list_apply_to_blob(
git_buffer *out,
git_filter_list *filters,
git_blob *blob)
{
git_buffer in = {
(char *)git_blob_rawcontent(blob), git_blob_rawsize(blob), 0
};
return git_filter_list_apply_to_data(out, filters, &in);
}
...@@ -8,12 +8,7 @@ ...@@ -8,12 +8,7 @@
#define INCLUDE_filter_h__ #define INCLUDE_filter_h__
#include "common.h" #include "common.h"
#include "buffer.h"
#include "array.h"
#include "git2/odb.h"
#include "git2/repository.h"
#include "git2/filter.h" #include "git2/filter.h"
#include "git2/sys/filter.h"
typedef enum { typedef enum {
GIT_CRLF_GUESS = -1, GIT_CRLF_GUESS = -1,
...@@ -24,61 +19,6 @@ typedef enum { ...@@ -24,61 +19,6 @@ typedef enum {
GIT_CRLF_AUTO, GIT_CRLF_AUTO,
} git_crlf_t; } git_crlf_t;
typedef struct git_filter_list git_filter_list;
/*
* FILTER API
*/
/*
* For any given path in the working directory, create a `git_filter_list`
* with the relevant filters that need to be applied.
*
* This will return 0 (success) but set the output git_filter_list to NULL
* if no filters are requested for the given file.
*
* @param filters Output newly created git_filter_list (or NULL)
* @param repo Repository object that contains `path`
* @param path Relative path of the file to be filtered
* @param mode Filtering direction (WT->ODB or ODB->WT)
* @return 0 on success (which could still return NULL if no filters are
* needed for the requested file), <0 on error
*/
extern int git_filter_list_load(
git_filter_list **filters,
git_repository *repo,
const char *path,
git_filter_mode_t mode);
/*
* Apply one or more filters to a data buffer.
*
* The source data must have been loaded as a `git_buf` object. Both the
* `source` and `dest` buffers are owned by the caller and must be freed
* once they are no longer needed.
*
* NOTE: Because of the double-buffering schema, the `source` buffer that
* contains the original file may be tampered once the filtering is
* complete. Regardless, the `dest` buffer will always contain the final
* result of the filtering
*
* @param dest Buffer to store the result of the filtering
* @param source Buffer containing the document to filter
* @param filters An already loaded git_filter_list
* @return 0 on success, an error code otherwise
*/
extern int git_filter_list_apply(
git_buf *dest,
git_buf *source,
git_filter_list *filters);
/*
* Free the git_filter_list
*
* @param filters A git_filter_list created by `git_filter_list_load`
*/
extern void git_filter_list_free(git_filter_list *filters);
/* /*
* Available filters * Available filters
*/ */
......
...@@ -183,7 +183,6 @@ int git_odb__hashfd_filtered( ...@@ -183,7 +183,6 @@ int git_odb__hashfd_filtered(
{ {
int error; int error;
git_buf raw = GIT_BUF_INIT; git_buf raw = GIT_BUF_INIT;
git_buf filtered = GIT_BUF_INIT;
if (!fl) if (!fl)
return git_odb__hashfd(out, fd, size, type); return git_odb__hashfd(out, fd, size, type);
...@@ -192,15 +191,18 @@ int git_odb__hashfd_filtered( ...@@ -192,15 +191,18 @@ int git_odb__hashfd_filtered(
* into memory to apply filters before beginning to calculate the hash * into memory to apply filters before beginning to calculate the hash
*/ */
if (!(error = git_futils_readbuffer_fd(&raw, fd, size))) if (!(error = git_futils_readbuffer_fd(&raw, fd, size))) {
error = git_filter_list_apply(&filtered, &raw, fl); git_buffer pre = GIT_BUFFER_FROM_BUF(&raw), post = GIT_BUFFER_INIT;
git_buf_free(&raw); error = git_filter_list_apply_to_data(&post, fl, &pre);
if (!error) git_buffer_free(&pre);
error = git_odb_hash(out, filtered.ptr, filtered.size, type);
git_buf_free(&filtered); if (!error)
error = git_odb_hash(out, post.ptr, post.size, type);
git_buffer_free(&post);
}
return error; return error;
} }
......
#include "clar_libgit2.h" #include "clar_libgit2.h"
#include "posix.h" #include "posix.h"
#include "blob.h" #include "blob.h"
#include "filter.h"
#include "buf_text.h" #include "buf_text.h"
static git_repository *g_repo = NULL; static git_repository *g_repo = NULL;
...@@ -105,7 +104,7 @@ void test_object_blob_filter__to_odb(void) ...@@ -105,7 +104,7 @@ void test_object_blob_filter__to_odb(void)
git_config *cfg; git_config *cfg;
int i; int i;
git_blob *blob; git_blob *blob;
git_buf orig = GIT_BUF_INIT, out = GIT_BUF_INIT; git_buffer out = GIT_BUFFER_INIT;
cl_git_pass(git_repository_config(&cfg, g_repo)); cl_git_pass(git_repository_config(&cfg, g_repo));
cl_assert(cfg); cl_assert(cfg);
...@@ -119,17 +118,18 @@ void test_object_blob_filter__to_odb(void) ...@@ -119,17 +118,18 @@ void test_object_blob_filter__to_odb(void)
for (i = 0; i < NUM_TEST_OBJECTS; i++) { for (i = 0; i < NUM_TEST_OBJECTS; i++) {
cl_git_pass(git_blob_lookup(&blob, g_repo, &g_oids[i])); cl_git_pass(git_blob_lookup(&blob, g_repo, &g_oids[i]));
cl_git_pass(git_blob__getbuf(&orig, blob));
cl_git_pass(git_filter_list_apply(&out, &orig, fl)); cl_git_pass(git_filter_list_apply_to_blob(&out, fl, blob));
cl_assert(git_buf_cmp(&out, &g_crlf_filtered[i]) == 0);
cl_assert(!memcmp(
out.ptr, g_crlf_filtered[i].ptr,
min(out.size, g_crlf_filtered[i].size)));
git_blob_free(blob); git_blob_free(blob);
} }
git_filter_list_free(fl); git_filter_list_free(fl);
git_buf_free(&orig); git_buffer_free(&out);
git_buf_free(&out);
git_config_free(cfg); git_config_free(cfg);
} }
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment